@wix/ditto-codegen-public 1.0.162 → 1.0.164

package/dist/docs-output/api-docs/crm-contacts-onContactCreated-doc.txt

@@ -1,183 +1,99 @@
 <crm_contacts_onContactCreated>
-<purpose>Registers a callback function as an event handler. Triggered when a contact is created. This method registers a callback function as an event handler. When developing websites or building apps with Blocks, use a Velo backend event instead of this method. The way you call this method differs depending on the framework you are working in: When using the CLI, run the generate command to add an event extension, and then call this method within the extension code. When building a self-hosted app, subscribe your app to the relevant event, and then call this method on your server.</purpose>
-<use_cases>
-- Trigger welcome emails or onboarding automations when a contact is created
-- Sync new contacts to external CRMs or marketing systems
-- Enrich newly created contacts with third-party data
-- Assign labels or segments to new contacts based on rules
-- Log contact creation events for analytics and monitoring
-</use_cases>
+<description>
+# This is a Webhook method
 
-<method_declaration>
-contacts.onContactCreated(handler)
-</method_declaration>
-<required_parameters>
-- handler: function - handler(event: ContactCreatedEnvelope): void | Promise<void>
-</required_parameters>
-<optional_parameters>
-None
-</optional_parameters>
-<import>import { contacts } from '@wix/crm'</import>
-<types>
+# Method name:
 
-**ContactCreatedEnvelope**
-Properties:
-- event: ContactCreatedEnvelope - The contact creation event envelope
+crm.contacts.onContactCreated(handler: OnContactCreatedHandler)
 
-**ContactCreatedEnvelope**
-Properties:
-- entity: Contact - The created contact entity
-- metadata: EventMetadata - Event metadata
+# Method Link:
 
-**Contact**
-Properties:
-- _createdDate: Date - Date and time the contact was created.
-- _id: string - Contact ID
-- _updatedDate: Date - Date and time the contact was last updated.
-- info: ContactInfo - Contact's details.
-- lastActivity: ContactActivity - Details about the contact's last action in the site.
-- primaryEmail: PrimaryEmail - Contact's primary email details.
-- primaryInfo: PrimaryContactInfo - Contact's primary phone and email.
-- primaryPhone: PrimaryPhone - Contact's primary phone details.
-- revision: number - Revision number, which increments by 1 each time the contact is updated. To prevent conflicting changes, the existing revision must be specified when updating a contact.
-- source: ContactSource - Details about the contact's source.
+https://dev.wix.com/docs/sdk/backend-modules/crm/contacts/on-contact-created
 
-**ContactInfo**
-Properties:
-- addresses: ContactAddressesWrapper - Contact's street addresses.
-- birthdate: string - Birth date in YYYY-MM-DD format. For example, 2020-03-15.
-- company: string - Contact's company name.
-- emails: ContactEmailsWrapper - Contact's email addresses.
-- extendedFields: ExtendedFieldsWrapper - Additional custom fields.
-- jobTitle: string - Contact's job title.
-- labelKeys?: LabelsWrapper - List of contact's labels.
-- locale: string - Locale in IETF BCP 47 language tag format.
-- name: ContactName - Contact's first and last name.
-- phones: ContactPhonesWrapper - Contact's phone numbers.
-- picture: ContactPicture - Contact's profile picture.
+# Method Description:
 
-**ContactAddressesWrapper**
-Properties:
-- items: ContactAddress[] - List of up to 50 addresses.
+Triggered when a contact is created.
 
-**ContactAddress**
-Properties:
-- _id: string - Street address ID.
-- address: Address - Street adress
-- tsg: AddressTag - Address type. UNTAGGED is shown as "Other" in the Contact List.
 
-**ContactEmailsWrapper**
-Properties:
-- items: ContactEmail[] - List of up to 50 email addresses.
+</description>
+<usage>
+import { contacts } from "@wix/crm";
 
-**ContactEmail**
-Properties:
-- _id: string - Email ID.
-- email: string - Email address
-- primary: boolean - Indicates whether this is the contact's primary email address. When changing primary to true for an email, the contact's other emails become false.
-- tage: EmailTag - Email type
-
-**ExtendedFieldsWrapper**
-Properties:
-- items: Record<string, any> - Contact's extended fields, where each key is the field key, and each value is the field's value for the contact.
-
-**LabelsWrapper**
-Properties:
-- items: string[] - List of contact label keys.
-
-**ContactName**
-Properties:
-- first: string - Contact's first name.
-- last: string - Contact's last name.
-
-**ContactPhonesWrapper**
-Properties:
-- items: ContactPhone[] - List of up to 50 phone numbers.
-
-**ContactActivity**
-Properties:
-- activityDate: Date - Date and time of the last action.
-- activityType: ContactActivityType - Contact's last action in the site.
-
-**PrimaryEmail**
-Properties:
-- deliverabilityStatus: EmailDeliverabilityStatus - Indicates last reported status of sent emails. Default: NOT_SET
-- email: string - Primary email address.
-- subscriptionStatus: SubscriptionStatus - Indicates the recipient's opt-in or opt-out status for marketing emails. Default: NOT_SET
-
-**PrimaryContactInfo**
-Properties:
-- email: string - Primary email address.
-- phone: string - Primary phone number.
-
-**PrimaryPhone**
-Properties:
-- countryCode: string - Country code of the primary phone number in ISO-3166 alpha-2 format.
-- e164Phone: string - Phone number in ITU E.164 format. Automatically generated using phone and countryCode when both values are valid.
-- formattedPhone: string - Formatted phone. Automatically generated using phone and countryCode.
-- phone: string - Primary phone number.
-- subscriptionStatus: SubscriptionStatus - Indicates the recipient's opt-in or opt-out status for SMS messages.
-
-**ContactSource**
-Properties:
-- appId: string - App ID, if the contact was created by an app.
-- sourceType: ContactSourceType - Source type
-
-**EventMetadata**
-Properties:
-- _id: string - Unique event ID
-- entityEventSequence: string - Sequence number for entity changes ordering
-- entityFqdn: string - Fully-qualified entity type (for example, wix.crm.contact)
-- entityId: string - ID of the entity associated with the event
-- eventTime: Date - Event timestamp in ISO-8601 format (UTC)
-- eventType: string - Event type
-- identity: IdentificationData - The identification type and identity data
-- instanceId: string - App instance ID
-- originatedFrom?: string - If present, indicates the action that triggered the event
-- slug: string - Event slug (for example, created)
-- triggeredByAnonymizeRequest?: boolean - Whether triggered by a privacy request
-</types>
-<important_notes>
-- This method registers a callback function as an event handler
-- When developing websites or building apps with Blocks, use a Velo backend event instead of this method
-- The way you call this method differs depending on the framework you are working in:
-  - When using the CLI, run the generate command to add an event extension, and then call this method within the extension code
-  - When building a self-hosted app, subscribe your app to the relevant event, and then call this method on your server
-- The handler function can be either synchronous (void) or asynchronous (Promise<void>)
-- Triggered when a contact is created
-- Required Permission: 'SCOPE.DC-CONTACTS.READ-CONTACTS'
-</important_notes>
-
-<event_triggers>
-- Contact Created: Triggered automatically when a new contact is successfully created in CRM
-</event_triggers>
-<example_usage>
-```typescript
-import { contacts } from '@wix/crm';
-
-// Register event handler for contact creation
-export default contacts.onContactCreated((event) => {
-  const created = event.entity;
-  console.log('New contact created:', created._id);
-  console.log('Primary email:', created.primaryInfo?.email);
-});
-
-// Async handler example
-export default contacts.onContactCreated(async (event) => {
-  const created = event.entity;
-  await syncToExternalCrm(created._id, created);
-});
+   contacts.onContactCreated((event) => {
+     // handle your event here
+   });
+   
+</usage>
+<type_definition>
 ```
-</example_usage>
-<related_methods>
-- contacts.onContactUpdated() - Event handler for contact updates
-- contacts.onContactDeleted() - Event handler for contact deletions
-- contacts.onContactMerged() - Event handler for contact merges
-- contacts.createContact() - Create a new contact
-- contacts.getContact() - Retrieve a contact by ID
-- contacts.updateContact() - Update an existing contact
-- contacts.queryContacts() - Query contacts
-- contacts.listContacts() - List contacts
-</related_methods>
-</crm_contacts_onContactCreated>
+Method: crm.contacts.onContactCreated(handler)
+Description: Triggered when a contact is created.
+Method parameters:
+  param name:  handler | type: OnContactCreatedHandler | description:  none 
+      - name: event  | type: ContactCreatedEnvelope | description:  none 
+          - name: entity  | type: Contact | description:  none 
+              - name: info  | type: ContactInfo | description:  Contact's details. 
+                  - name: addresses  | type: ContactAddressesWrapper | description:  Contact's street addresses. 
+                      - name: items  | type: Array<ContactAddress> | description:  List of up to 50 addresses. 
+                            - name: address  | type: Address | description:  Street address. 
+                                - name: addressLine1  | type: string | description:  Main address line, usually street and number, as free text. 
+                                - name: addressLine2  | type: string | description:  Free text providing more detailed address information, such as apartment, suite, or floor. 
+                                - name: city  | type: string | description:  City name. 
+                                - name: country  | type: string | description:  2-letter country code in an [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. 
+                                - name: postalCode  | type: string | description:  Postal or zip code. 
+                                - name: subdivision  | type: string | description:  Code for a subdivision (such as state, prefecture, or province) in an [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) format. 
+                                - ONE-OF: 
+                                  - name: addressLine  | type: string | description:  Main address line, usually street and number, as free text. 
+                                  - name: streetAddress  | type: StreetAddress | description:  Street address object, with number and name in separate fields. 
+                                      - name: name  | type: string | description:  Street name. 
+                                      - name: number  | type: string | description:  Street number. 
+                            - name: tag  | type: AddressTag | description:  Address type. `UNTAGGED` is shown as "Other" in the Contact List. 
+                                enum: BILLING, HOME, SHIPPING, UNTAGGED, WORK
+                  - name: birthdate  | type: string | description:  Birth date in `YYYY-MM-DD` format. For example, `2020-03-15`. 
+                  - name: company  | type: string | description:  Contact's company name. 
+                  - name: emails  | type: ContactEmailsWrapper | description:  Contact's email addresses. 
+                      - name: items  | type: Array<ContactEmail> | description:  List of up to 50 email addresses. 
+                            - name: email  | type: string | description:  Email address. 
+                            - name: primary  | type: boolean | description:  Indicates whether this is the contact's primary email address. When changing `primary` to `true` for an email, the contact's other emails become `false`. Changing the primary email of a contact also affects the subscription status to marketing emails that are decided based on the primary email. 
+                            - name: tag  | type: EmailTag | description:  Email type.  `UNTAGGED` is shown as "Other" in the Contact List. 
+                                enum: HOME, MAIN, UNTAGGED, WORK
+                  - name: extendedFields  | type: ExtendedFieldsWrapper | description:  Additional custom fields.  Empty fields are not returned. 
+                      - name: items  | type: Record<string, any> | description:  Contact's extended fields, where each key is the field key, and each value is the field's value for the contact.  To view and manage extended fields, use the Extended Fields API. 
+                  - name: jobTitle  | type: string | description:  Contact's job title. 
+                  - name: labelKeys  | type: LabelsWrapper | description:  List of contact's labels.  Labels are used to organize contacts. Labels can be added and removed using Label Contact and Unlabel Contact, respectively.  To view or manage contact labels, use the Labels API. 
+                      - name: items  | type: Array<string> | description:  List of contact label keys.  Contact labels help categorize contacts. Label keys must exist to be added to the contact. Contact labels can be created or retrieved with Find or Create Label or List Labels. 
+                  - name: locale  | type: string | description:  Locale in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format. Typically, this is a lowercase 2-letter language code, followed by a hyphen, followed by an uppercase 2-letter country code. For example, `en-US` for U.S. English, and `de-DE` for Germany German. 
+                  - name: name  | type: ContactName | description:  Contact's first and last name. 
+                      - name: first  | type: string | description:  Contact's first name. 
+                      - name: last  | type: string | description:  Contact's last name. 
+                  - name: phones  | type: ContactPhonesWrapper | description:  Contact's phone numbers. 
+                      - name: items  | type: Array<ContactPhone> | description:  List of up to 50 phone numbers. 
+                            - name: countryCode  | type: string | description:  [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code. 
+                            - name: phone  | type: string | description:  Phone number. 
+                            - name: primary  | type: boolean | description:  Indicates whether this is the contact's primary phone number. When changing `primary` to `true` for a phone, the contact's `primary` field for other phones becomes `false`. Changing the primary phone number also affects the subscription status to SMS messages that are decided based on the primary phone. 
+                            - name: tag  | type: PhoneTag | description:  Phone type.  `UNTAGGED` is shown as "Other" in the Contact List. 
+                                enum: FAX, HOME, MAIN, MOBILE, UNTAGGED, WORK
+                  - name: picture  | type: ContactPicture | description:  Contact's profile picture. 
+                      - name: image  | type: string | description:  Image. This can contain an image URL or a Wix Media image GUID. 
+          - name: metadata  | type: EventMetadata | description:  none 
+              - name: _id  | type: string | description:  Event GUID. With this GUID you can easily spot duplicated events and ignore them. 
+              - name: entityEventSequence  | type: string | description:  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. 
+              - name: entityFqdn  | type: string | description:  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`. 
+              - name: entityId  | type: string | description:  GUID of the entity associated with the event. 
+              - name: eventTime  | type: Date | description:  Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. 
+              - name: eventType  | type: string | description:  Event type. 
+              - name: identity  | type: IdentificationData | description:  The identification type and identity data. 
+                  - ONE-OF: 
+                    - name: anonymousVisitorId  | type: string | description:  GUID of a site visitor that has not logged in to the site. 
+                    - name: appId  | type: string | description:  GUID of an app. 
+                    - name: memberId  | type: string | description:  GUID of a site visitor that has logged in to the site. 
+                    - name: wixUserId  | type: string | description:  GUID of a Wix user (site owner, contributor, etc.). 
+              - name: instanceId  | type: string | description:  App instance GUID. 
+              - name: originatedFrom  | type: string | description:  If present, indicates the action that triggered the event. 
+              - name: slug  | type: string | description:  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`. 
+              - name: triggeredByAnonymizeRequest  | type: boolean | description:  Whether the event was triggered as a result of a privacy regulation application (for example, GDPR). 
+Return type: PRIMITIVE<void>
 
+```
+</type_definition>
+</crm_contacts_onContactCreated>

package/dist/docs-output/api-docs/crm-contacts-onContactDeleted-doc.txt

@@ -0,0 +1,58 @@
+<crm_contacts_onContactDeleted>
+<description>
+# This is a Webhook method
+
+# Method name:
+
+crm.contacts.onContactDeleted(handler: OnContactDeletedHandler)
+
+# Method Link:
+
+https://dev.wix.com/docs/sdk/backend-modules/crm/contacts/on-contact-deleted
+
+# Method Description:
+
+Triggered when a contact is deleted.
+
+If a contact is deleted as part of a merge, the `originatedFrom` property is sent as `merge`.
+Otherwise, `originatedFrom` isn't returned.
+
+
+</description>
+<usage>
+import { contacts } from "@wix/crm";
+
+   contacts.onContactDeleted((event) => {
+     // handle your event here
+   });
+   
+</usage>
+<type_definition>
+```
+Method: crm.contacts.onContactDeleted(handler)
+Description: Triggered when a contact is deleted.  If a contact is deleted as part of a merge, the `originatedFrom` property is sent as `merge`. Otherwise, `originatedFrom` isn't returned.
+Method parameters:
+  param name:  handler | type: OnContactDeletedHandler | description:  none 
+      - name: event  | type: ContactDeletedEnvelope | description:  none 
+          - name: metadata  | type: EventMetadata | description:  none 
+              - name: _id  | type: string | description:  Event GUID. With this GUID you can easily spot duplicated events and ignore them. 
+              - name: entityEventSequence  | type: string | description:  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. 
+              - name: entityFqdn  | type: string | description:  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`. 
+              - name: entityId  | type: string | description:  GUID of the entity associated with the event. 
+              - name: eventTime  | type: Date | description:  Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. 
+              - name: eventType  | type: string | description:  Event type. 
+              - name: identity  | type: IdentificationData | description:  The identification type and identity data. 
+                  - ONE-OF: 
+                    - name: anonymousVisitorId  | type: string | description:  GUID of a site visitor that has not logged in to the site. 
+                    - name: appId  | type: string | description:  GUID of an app. 
+                    - name: memberId  | type: string | description:  GUID of a site visitor that has logged in to the site. 
+                    - name: wixUserId  | type: string | description:  GUID of a Wix user (site owner, contributor, etc.). 
+              - name: instanceId  | type: string | description:  App instance GUID. 
+              - name: originatedFrom  | type: string | description:  If present, indicates the action that triggered the event. 
+              - name: slug  | type: string | description:  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`. 
+              - name: triggeredByAnonymizeRequest  | type: boolean | description:  Whether the event was triggered as a result of a privacy regulation application (for example, GDPR). 
+Return type: PRIMITIVE<void>
+
+```
+</type_definition>
+</crm_contacts_onContactDeleted>

package/dist/docs-output/api-docs/crm-contacts-onContactUpdated-doc.txt

@@ -0,0 +1,99 @@
+<crm_contacts_onContactUpdated>
+<description>
+# This is a Webhook method
+
+# Method name:
+
+crm.contacts.onContactUpdated(handler: OnContactUpdatedHandler)
+
+# Method Link:
+
+https://dev.wix.com/docs/sdk/backend-modules/crm/contacts/on-contact-updated
+
+# Method Description:
+
+Triggered when a contact is updated.
+
+
+</description>
+<usage>
+import { contacts } from "@wix/crm";
+
+   contacts.onContactUpdated((event) => {
+     // handle your event here
+   });
+   
+</usage>
+<type_definition>
+```
+Method: crm.contacts.onContactUpdated(handler)
+Description: Triggered when a contact is updated.
+Method parameters:
+  param name:  handler | type: OnContactUpdatedHandler | description:  none 
+      - name: event  | type: ContactUpdatedEnvelope | description:  none 
+          - name: entity  | type: Contact | description:  none 
+              - name: info  | type: ContactInfo | description:  Contact's details. 
+                  - name: addresses  | type: ContactAddressesWrapper | description:  Contact's street addresses. 
+                      - name: items  | type: Array<ContactAddress> | description:  List of up to 50 addresses. 
+                            - name: address  | type: Address | description:  Street address. 
+                                - name: addressLine1  | type: string | description:  Main address line, usually street and number, as free text. 
+                                - name: addressLine2  | type: string | description:  Free text providing more detailed address information, such as apartment, suite, or floor. 
+                                - name: city  | type: string | description:  City name. 
+                                - name: country  | type: string | description:  2-letter country code in an [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. 
+                                - name: postalCode  | type: string | description:  Postal or zip code. 
+                                - name: subdivision  | type: string | description:  Code for a subdivision (such as state, prefecture, or province) in an [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) format. 
+                                - ONE-OF: 
+                                  - name: addressLine  | type: string | description:  Main address line, usually street and number, as free text. 
+                                  - name: streetAddress  | type: StreetAddress | description:  Street address object, with number and name in separate fields. 
+                                      - name: name  | type: string | description:  Street name. 
+                                      - name: number  | type: string | description:  Street number. 
+                            - name: tag  | type: AddressTag | description:  Address type. `UNTAGGED` is shown as "Other" in the Contact List. 
+                                enum: BILLING, HOME, SHIPPING, UNTAGGED, WORK
+                  - name: birthdate  | type: string | description:  Birth date in `YYYY-MM-DD` format. For example, `2020-03-15`. 
+                  - name: company  | type: string | description:  Contact's company name. 
+                  - name: emails  | type: ContactEmailsWrapper | description:  Contact's email addresses. 
+                      - name: items  | type: Array<ContactEmail> | description:  List of up to 50 email addresses. 
+                            - name: email  | type: string | description:  Email address. 
+                            - name: primary  | type: boolean | description:  Indicates whether this is the contact's primary email address. When changing `primary` to `true` for an email, the contact's other emails become `false`. Changing the primary email of a contact also affects the subscription status to marketing emails that are decided based on the primary email. 
+                            - name: tag  | type: EmailTag | description:  Email type.  `UNTAGGED` is shown as "Other" in the Contact List. 
+                                enum: HOME, MAIN, UNTAGGED, WORK
+                  - name: extendedFields  | type: ExtendedFieldsWrapper | description:  Additional custom fields.  Empty fields are not returned. 
+                      - name: items  | type: Record<string, any> | description:  Contact's extended fields, where each key is the field key, and each value is the field's value for the contact.  To view and manage extended fields, use the Extended Fields API. 
+                  - name: jobTitle  | type: string | description:  Contact's job title. 
+                  - name: labelKeys  | type: LabelsWrapper | description:  List of contact's labels.  Labels are used to organize contacts. Labels can be added and removed using Label Contact and Unlabel Contact, respectively.  To view or manage contact labels, use the Labels API. 
+                      - name: items  | type: Array<string> | description:  List of contact label keys.  Contact labels help categorize contacts. Label keys must exist to be added to the contact. Contact labels can be created or retrieved with Find or Create Label or List Labels. 
+                  - name: locale  | type: string | description:  Locale in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format. Typically, this is a lowercase 2-letter language code, followed by a hyphen, followed by an uppercase 2-letter country code. For example, `en-US` for U.S. English, and `de-DE` for Germany German. 
+                  - name: name  | type: ContactName | description:  Contact's first and last name. 
+                      - name: first  | type: string | description:  Contact's first name. 
+                      - name: last  | type: string | description:  Contact's last name. 
+                  - name: phones  | type: ContactPhonesWrapper | description:  Contact's phone numbers. 
+                      - name: items  | type: Array<ContactPhone> | description:  List of up to 50 phone numbers. 
+                            - name: countryCode  | type: string | description:  [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code. 
+                            - name: phone  | type: string | description:  Phone number. 
+                            - name: primary  | type: boolean | description:  Indicates whether this is the contact's primary phone number. When changing `primary` to `true` for a phone, the contact's `primary` field for other phones becomes `false`. Changing the primary phone number also affects the subscription status to SMS messages that are decided based on the primary phone. 
+                            - name: tag  | type: PhoneTag | description:  Phone type.  `UNTAGGED` is shown as "Other" in the Contact List. 
+                                enum: FAX, HOME, MAIN, MOBILE, UNTAGGED, WORK
+                  - name: picture  | type: ContactPicture | description:  Contact's profile picture. 
+                      - name: image  | type: string | description:  Image. This can contain an image URL or a Wix Media image GUID. 
+          - name: metadata  | type: EventMetadata | description:  none 
+              - name: _id  | type: string | description:  Event GUID. With this GUID you can easily spot duplicated events and ignore them. 
+              - name: entityEventSequence  | type: string | description:  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. 
+              - name: entityFqdn  | type: string | description:  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`. 
+              - name: entityId  | type: string | description:  GUID of the entity associated with the event. 
+              - name: eventTime  | type: Date | description:  Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. 
+              - name: eventType  | type: string | description:  Event type. 
+              - name: identity  | type: IdentificationData | description:  The identification type and identity data. 
+                  - ONE-OF: 
+                    - name: anonymousVisitorId  | type: string | description:  GUID of a site visitor that has not logged in to the site. 
+                    - name: appId  | type: string | description:  GUID of an app. 
+                    - name: memberId  | type: string | description:  GUID of a site visitor that has logged in to the site. 
+                    - name: wixUserId  | type: string | description:  GUID of a Wix user (site owner, contributor, etc.). 
+              - name: instanceId  | type: string | description:  App instance GUID. 
+              - name: originatedFrom  | type: string | description:  If present, indicates the action that triggered the event. 
+              - name: slug  | type: string | description:  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`. 
+              - name: triggeredByAnonymizeRequest  | type: boolean | description:  Whether the event was triggered as a result of a privacy regulation application (for example, GDPR). 
+Return type: PRIMITIVE<void>
+
+```
+</type_definition>
+</crm_contacts_onContactUpdated>

package/dist/docs-output/api-docs/data-items-get-doc.txt

@@ -1,64 +1,105 @@
 <data_items_get>
-<use_cases>
-- Retrieve a single item from a collection by its ID
-- Display detailed information about a specific record (e.g., user profile, product details)
-- Fetch item data before performing updates or validation
-- Load specific content for viewing or editing
-- Retrieve configuration or settings stored in single-item collections
-- Get referenced item IDs for additional queries
-- Fetch data for specific records based on user selection
-- Access items by known identifiers from external systems
-</use_cases>
-
-<usage>
+<description>
+# Method name:
 
+data.items.get(dataCollectionId: string, itemId: string, options: WixDataReadWithProjectionOptions)
+
+# Method Link:
+
+https://dev.wix.com/docs/sdk/backend-modules/data/items/get
+
+# Method Description:
+
+Retrieves an item from a collection.
+
+The `get()` method returns a Promise that resolves to the item with ID
+`itemId` from the specified collection, or `null` if the `itemId` is not
+found. The Promise is rejected if the current user does not have read
+permissions for the collection.
+
+If the specified collection contains reference fields, the ID of the
+referenced item is returned. To return the values of the referenced items
+use `query()` and `include()`.
+
+If the `get()` method is passed the ID of [a hidden item](https://support.wix.com/en/article/cms-controlling-live-site-item-visibility-from-your-collection), it returns null.
+
+Calling the `get()` method triggers the [`beforeGet()`](https://dev.wix.com/docs/velo/api-reference/wix-data/hooks/before-get) and [`afterGet()`](https://dev.wix.com/docs/velo/api-reference/wix-data/hooks/after-get) hooks if they have been defined.
+
+> **Notes:**
+> - When using the `query()` or `get()` methods or another data retrieval method immediately following a change to your database collection, the data retrieved may not contain your most recent changes. Learn more about [Wix Data and eventual consistency](https://dev.wix.com/docs/sdk/backend-modules/data/eventual-consistency). To solve this, you can use the `setTimeout()` method to delay retrieving data following any changes to your database collection.
+> - To speed up data retrieval, the results of certain data queries are cached. Learn more about [caching data query results](https://dev.wix.com/docs/develop-websites/articles/databases/wix-data/data-api/about-caching-data-query-results).
+> - An `itemId` is required to retrieve an item even from a [single-item collection](https://support.wix.com/en/article/cms-adding-and-setting-up-a-single-item-collection).
+
+# Method Permissions:
+
+- Read Data Items
+
+# Method Permissions Scopes IDs:
+
+- SCOPE.DC-DATA.READ
+
+
+
+# Method Code Examples:
+
+## Get an item from a collection
+
+```javascript
 import { items } from "@wix/data";
 
 async function getItem() {
-  const retrievedItem = await items.get("myCollection", "00001");
-  console.log(retrievedItem); // See below
+ const item = await items.get("myCollection", "00001");
+ console.log(item);
 }
 
-/*  retrievedItem is:
- *
- *  {
- *    "_id":          "00001",
- *    "_owner":       "ffdkj9c2-df8g-f9ke-lk98-4kjhfr89keedb",
- *    "_createdDate": "2017-05-24T12:33:18.938Z",
- *    "_updatedDate": "2017-05-24T12:33:18.938Z",
- *    "title":        "Mr.",
- *    "first_name":   "John",
- *    "last_name":    "Doe"
- *  }
- */
-
-// Get specific fields only
-async function getItemWithFields() {
-  const item = await items.get("myCollection", "00001", {
-    fields: ["title", "first_name", "last_name"]
-  });
-  // Returns only the specified fields plus system fields (_id, _owner, etc.)
-}
-</usage>
+/*  item is:
+*
+*  {
+*    "_id":          "00001",
+*    "_owner":       "ffdkj9c2-df8g-f9ke-lk98-4kjhfr89keedb",
+*    "_createdDate": "2017-05-24T12:33:18.938Z",
+*    "_updatedDate": "2017-05-24T12:33:18.938Z",
+*    "title":        "Mr.",
+*    "first_name":   "John",
+*    "last_name":    "Doe"
+*  }
+*/
+```
+
+
 
+## default
+
+```javascript
+try {
+     const result = await items.get("collection-0.6451284333427125", "6892593d-d57f-428d-bc53-3f0870a1beef", {});
+     return result;
+   } catch (error) {
+     console.error(error);
+     throw error;
+  }
+```
+</description>
 <type_definition>
- Method: data.items.get(dataCollectionId, itemId, options)
- Description: Retrieves an item from a collection.  The `get()` method returns a Promise that resolves to the item with GUID `itemId` from the specified collection, or `null` if the `itemId` is not found. The Promise is rejected if the current user does not have read permissions for the collection.  If the specified collection contains reference fields, the GUID of the referenced item is returned. To return the values of the referenced items use `query()` and `include()`.  If the `get()` method is passed the GUID of [a hidden item](https://support.wix.com/en/article/cms-controlling-live-site-item-visibility-from-your-collection), it returns null.  Calling the `get()` method triggers the [`beforeGet()`](https://dev.wix.com/docs/velo/api-reference/wix-data/hooks/before-get) and [`afterGet()`](https://dev.wix.com/docs/velo/api-reference/wix-data/hooks/after-get) hooks if they have been defined.  > **Notes:** > - When using the `query()` or `get()` methods or another data retrieval method immediately following a change to your database collection, the data retrieved may not contain your most recent changes. Learn more about [Wix Data and eventual consistency](https://dev.wix.com/docs/sdk/backend-modules/data/eventual-consistency). To solve this, you can use the `setTimeout()` method to delay retrieving data following any changes to your database collection. > - To speed up data retrieval, the results of certain data queries are cached. Learn more about [caching data query results](https://dev.wix.com/docs/develop-websites/articles/databases/wix-data/data-api/about-caching-data-query-results). > - An `itemId` is required to retrieve an item even from a [single-item collection](https://support.wix.com/en/article/cms-adding-and-setting-up-a-single-item-collection).
- Method parameters:
-   param name:  dataCollectionId | type: string | description:  GUID of the collection item belongs to.
-   param name:  itemId | type: string | description:  GUID of the data item to retrieve. | required: true
-   param name:  options | type: WixDataReadWithProjectionOptions | description:  Options to use when processing this operation.
-       - name: appOptions  | type: Record<string, any> | description:  Options for [querying Wix app collections](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-app-collections/querying-wix-app-collections).
-       - name: consistentRead  | type: boolean | description:  When `true`, reads data from the primary database instance. This decreases performance but ensures data retrieved is up-to-date even immediately after an update. Learn more about [Wix Data and eventual consistency](https://dev.wix.com/docs/sdk/backend-modules/data/eventual-consistency).
-       - name: fields  | type: Array<string> | description:  Lists of fields to return in a result.
-       - name: language  | type: string | description:  Language to translate result text into, in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format. If provided, the result text is returned in the specified language. If not provided, the result text is not translated.  > **Note:** Translation for the specified language must be enabled for the collection in [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual).
-       - name: showDrafts  | type: boolean | description:  When `true`, operations include draft items. Read operations include draft items in their response, and write operations modify draft items.  Default: `false`.
-       - name: suppressHooks  | type: boolean | description:  Prevents hooks from running for the operation. Can only be used in the [backend code of a Wix site](https://dev.wix.com/docs/develop-websites/articles/coding-with-velo/backend-code/about-the-site-backend).  Default: `false`.
- Return type: PROMISE<WixDataItem>
-       - name: _createdDate  | type: Date | description:  Date and time the item was added to the collection.
-       - name: _id  | type: string | description:  Data item GUID.
-       - name: _owner  | type: string | description:  GUID of the user who created the item. Can be modified with site owner permissions.
-       - name: _updatedDate  | type: Date | description:  Date and time the item was last modified. When the item is first inserted, `_createdDate` and `_updatedDate` have the same value.
-</type_definition>
-</data_items_get>
+```
+Method: data.items.get(dataCollectionId, itemId, options)
+Description: Retrieves an item from a collection.  The `get()` method returns a Promise that resolves to the item with GUID `itemId` from the specified collection, or `null` if the `itemId` is not found. The Promise is rejected if the current user does not have read permissions for the collection.  If the specified collection contains reference fields, the GUID of the referenced item is returned. To return the values of the referenced items use `query()` and `include()`.  If the `get()` method is passed the GUID of [a hidden item](https://support.wix.com/en/article/cms-controlling-live-site-item-visibility-from-your-collection), it returns null.  Calling the `get()` method triggers the [`beforeGet()`](https://dev.wix.com/docs/velo/api-reference/wix-data/hooks/before-get) and [`afterGet()`](https://dev.wix.com/docs/velo/api-reference/wix-data/hooks/after-get) hooks if they have been defined.  > **Notes:** > - When using the `query()` or `get()` methods or another data retrieval method immediately following a change to your database collection, the data retrieved may not contain your most recent changes. Learn more about [Wix Data and eventual consistency](https://dev.wix.com/docs/sdk/backend-modules/data/eventual-consistency). To solve this, you can use the `setTimeout()` method to delay retrieving data following any changes to your database collection. > - To speed up data retrieval, the results of certain data queries are cached. Learn more about [caching data query results](https://dev.wix.com/docs/develop-websites/articles/databases/wix-data/data-api/about-caching-data-query-results). > - An `itemId` is required to retrieve an item even from a [single-item collection](https://support.wix.com/en/article/cms-adding-and-setting-up-a-single-item-collection).
+Method parameters:
+  param name:  dataCollectionId | type: string | description:  GUID of the collection item belongs to. 
+  param name:  itemId | type: string | description:  GUID of the data item to retrieve. | required: true
+  param name:  options | type: WixDataReadWithProjectionOptions | description:  Options to use when processing this operation. 
+      - name: appOptions  | type: Record<string, any> | description:  Options for [querying Wix app collections](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-app-collections/querying-wix-app-collections). 
+      - name: consistentRead  | type: boolean | description:  When `true`, reads data from the primary database instance. This decreases performance but ensures data retrieved is up-to-date even immediately after an update. Learn more about [Wix Data and eventual consistency](https://dev.wix.com/docs/sdk/backend-modules/data/eventual-consistency). 
+      - name: fields  | type: Array<string> | description:  Lists of fields to return in a result. 
+      - name: language  | type: string | description:  Language to translate result text into, in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format. If provided, the result text is returned in the specified language. If not provided, the result text is not translated.  > **Note:** Translation for the specified language must be enabled for the collection in [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual). 
+      - name: showDrafts  | type: boolean | description:  When `true`, operations include draft items. Read operations include draft items in their response, and write operations modify draft items.  Default: `false`. 
+      - name: suppressHooks  | type: boolean | description:  Prevents hooks from running for the operation. Can only be used in the [backend code of a Wix site](https://dev.wix.com/docs/develop-websites/articles/coding-with-velo/backend-code/about-the-site-backend).  Default: `false`. 
+Return type: PROMISE<WixDataItem>
+      - name: _createdDate  | type: Date | description:  Date and time the item was added to the collection. 
+      - name: _id  | type: string | description:  Data item GUID. 
+      - name: _owner  | type: string | description:  GUID of the user who created the item. Can be modified with site owner permissions. 
+      - name: _updatedDate  | type: Date | description:  Date and time the item was last modified. When the item is first inserted, `_createdDate` and `_updatedDate` have the same value. 
 
+```
+</type_definition>
+</data_items_get>