@wix/ditto-codegen-public 1.0.162 → 1.0.164

package/dist/docs-output/api-docs/ecom-checkout-onCheckoutCompleted-doc.txt

@@ -0,0 +1,151 @@
+<ecom_checkout_onCheckoutCompleted>
+<description>
+# This is a Webhook method
+
+# Method name:
+
+ecom.checkout.onCheckoutCompleted(handler: OnCheckoutCompletedHandler)
+
+# Method Link:
+
+https://dev.wix.com/docs/sdk/backend-modules/ecom/checkout/on-checkout-completed
+
+# Method Description:
+
+Triggered when an order created from this checkout is successfully paid for or when a checkout is marked as completed.
+
+
+</description>
+<usage>
+import { checkout } from "@wix/ecom";
+
+   checkout.onCheckoutCompleted((event) => {
+     // handle your event here
+   });
+   
+</usage>
+<type_definition>
+```
+Method: ecom.checkout.onCheckoutCompleted(handler)
+Description: Triggered when an order created from this checkout is successfully paid for or when a checkout is marked as completed.
+Method parameters:
+  param name:  handler | type: OnCheckoutCompletedHandler | description:  none 
+      - name: event  | type: CheckoutCompletedEnvelope | description:  none 
+          - name: data  | type: CheckoutMarkedAsCompleted | description:  none 
+              - name: checkout  | type: Checkout | description:  none 
+                  - name: additionalFees  | type: Array<AdditionalFee> | description:  Additional Fees. 
+                        - name: code  | type: string | description:  Additional fee's unique code (or GUID) for future processing. 
+                        - name: lineItemIds  | type: Array<string> | description:  Optional - Line items associated with this additional fee. If no `lineItemIds` are provided, the fee will be associated with the whole cart/checkout/order. 
+                        - name: name  | type: string | description:  Translated additional fee's name. 
+                        - name: price  | type: MultiCurrencyPrice | description:  Additional fee's price. 
+                            - name: amount  | type: string | description:  Amount. 
+                        - name: priceAfterTax  | type: MultiCurrencyPrice | description:  Additional fee's price after tax. 
+                        - name: priceBeforeTax  | type: MultiCurrencyPrice | description:  Additional fee's price before tax. 
+                        - name: providerAppId  | type: string | description:  Provider's app id. 
+                        - name: source  | type: AdditionalFeeSource | description:  the source the additional fee was added from 
+                            enum: 
+                                 ITEM: The additional fee was added on the item either via the catalog or on custom line item
+                                 MANUAL: The additional fee was added manually on the request
+                                 SERVICE_PLUGIN: The additional fee was added by an additional fee service plugin
+                                 SHIPPING: The additional fee was added by the shipping provider
+                               UNKNOWN_ADDITIONAL_FEE_SOURCE
+                        - name: taxDetails  | type: ItemTaxFullDetails | description:  Tax details. 
+                            - name: taxRate  | type: string | description:  Tax rate %, as a decimal point between 0 and 1. 
+                            - name: taxableAmount  | type: MultiCurrencyPrice | description:  Amount for which tax is calculated. 
+                            - name: totalTax  | type: MultiCurrencyPrice | description:  Calculated tax, based on `taxable_amount` and `tax_rate`. 
+                        - name: translatedName  | type: string | description:  The translated name of the additional fee. The translation language is determined by the `languages` field in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope). 
+                  - name: billingInfo  | type: AddressWithContact | description:  Billing information. 
+                      - name: address  | type: ApiAddress | description:  Address. 
+                          - name: addressLine1  | type: string | description:  Main address line (usually street name and number). 
+                          - name: addressLine2  | type: string | description:  Free text providing more detailed address info. Usually contains apt, suite, floor. 
+                          - name: city  | type: string | description:  City name. 
+                          - name: country  | type: string | description:  Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format. 
+                          - name: location  | type: AddressLocation | description:  Geocode object containing latitude and longitude coordinates. 
+                              - name: latitude  | type: number | description:  Address latitude. 
+                              - name: longitude  | type: number | description:  Address longitude. 
+                          - name: postalCode  | type: string | description:  Postal or zip code. 
+                          - name: streetAddress  | type: StreetAddress | description:  Street address. 
+                              - name: name  | type: string | description:  Street name. 
+                              - name: number  | type: string | description:  Street number. 
+                          - name: subdivision  | type: string | description:  Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format. 
+                      - name: contactDetails  | type: FullAddressContactDetails | description:  Contact details. 
+                          - name: company  | type: string | description:  Company name. 
+                          - name: firstName  | type: string | description:  First name. 
+                          - name: lastName  | type: string | description:  Last name. 
+                          - name: phone  | type: string | description:  Phone number. 
+                          - name: vatId  | type: CommonVatId | description:  Tax information (for Brazil only). If GUID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. 
+                              - name: _id  | type: string | description:  Customer's tax GUID. 
+                              - name: type  | type: CommonVatType | description:  Tax type.  Supported values: + `CPF`: for individual tax payers + `CNPJ`: for corporations 
+                                  enum: 
+                                       CNPJ: CNPJ - for corporations
+                                       CPF: CPF - for individual tax payers.
+                                     UNSPECIFIED
+                  - name: businessLocationId  | type: string | description:  The business location GUID associated with the checkout.  To learn more, see the Locations API. 
+                  - name: buyerInfo  | type: BuyerInfo | description:  Buyer information. 
+                      - name: email  | type: string | description:  Buyer email address. 
+                      - ONE-OF: 
+                        - name: memberId  | type: string | description:  Member GUID (if site visitor is a site member). 
+                        - name: visitorId  | type: string | description:  Visitor GUID (if site visitor is **not** a member). 
+                  - name: buyerNote  | type: string | description:  [Buyer note](https://support.wix.com/en/article/collecting-and-viewing-buyer-notes) left by the customer. 
+                  - name: cartId  | type: string | description:  Cart GUID that this checkout was created from. Empty if this checkout wasn't created from a cart. 
+                  - name: customContentReference  | type: CustomContentReference | description:  Reference GUIDs for the app and component providing custom checkout page content.  To access and manage custom checkout page content, your app must have the permission scope named "Manage eCommerce - Admin Permissions". Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions). 
+                      - name: appId  | type: string | description:  GUID of the app providing the content.  You can get your app's GUID from its page in the [app dashboard](https://dev.wix.com/dc3/my-apps/). 
+                      - name: componentId  | type: string | description:  GUID of the component within the app it belongs to.  You can get your component's GUID from its page in the [app dashboard](https://dev.wix.com/dc3/my-apps/). 
+                  - name: customFields  | type: Array<CustomField> | description:  Custom fields. 
+                        - name: title  | type: string | description:  Custom field title. 
+                        - name: translatedTitle  | type: string | description:  Translated custom field title. 
+                        - name: value  | type: any | description:  Custom field value. 
+                  - name: customSettings  | type: CustomSettings | description:  Additional settings for customization of the checkout process.  > **Notes:** > * Custom settings can only be set when creating a checkout. > * To access and manage custom checkout page content, your app must have the permission scope named "Manage eCommerce - Admin Permissions". Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions). 
+                      - name: disabledManualPayment  | type: boolean | description:  Whether to disable manual payment option for this checkout.  Default: `false` 
+                      - name: disabledPolicyAgreementCheckbox  | type: boolean | description:  Whether to disable policy agreement checkout in the checkout page  Default: `false` 
+                      - name: lockCouponCode  | type: boolean | description:  Whether to restrict the option to add or remove a coupon code on the checkout page.  Default: `false` 
+                      - name: lockGiftCard  | type: boolean | description:  Whether to restrict the option to add or remove a gift card on the checkout page.  Default: `false` 
+                  - name: extendedFields  | type: ExtendedFields | description:  Custom field data for the checkout object.  [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the app dashboard before they can be accessed with API calls. 
+                      - name: namespaces  | type: Record<string, undefined> | description:  Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured.  You can only access fields for which you have the appropriate permissions.  Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields). 
+                  - name: externalReference  | type: ExternalReference | description:  References to an external app and resource associated with this checkout. Used for integration and tracking across different platforms. 
+                      - name: appId  | type: string | description:  GUID of the app associated with the purchase flow. For example, the Wix Pay Links app GUID. 
+                      - name: resourceId  | type: string | description:  Reference to an external resource GUID. Used to link the purchase flow to a specific entity in an external system. For example, a Wix Pay Link GUID. 
+                  - name: membershipOptions  | type: MembershipOptions | description:  Memberships to apply when creating the order. 
+                      - name: selectedMemberships  | type: SelectedMemberships | description:  Selected membership to apply to this checkout. 
+                          - name: memberships  | type: Array<SelectedMembership> | description:  Selected memberships. 
+                                - name: _id  | type: string | description:  Membership GUID. 
+                                - name: appId  | type: string | description:  GUID of the app providing this payment option. 
+                                - name: lineItemIds  | type: Array<string> | description:  IDs of the line items this membership applies to. 
+                  - name: shippingInfo  | type: ShippingInfo | description:  Shipping information. 
+                      - name: selectedCarrierServiceOption  | type: SelectedCarrierServiceOption | description:  Selected option out of the options allowed for the `region`. 
+                          - name: carrierId  | type: string | description:  This carrier's unique GUID 
+                          - name: code  | type: string | description:  Unique identifier of selected option. For example, "usps_std_overnight". 
+                          - name: deliveryAllocations  | type: Array<DeliveryAllocation> | description:  Delivery solution allocations to different delivery carriers and delivery regions 
+                                - name: applicableLineItems  | type: ApplicableLineItems | description:  Populated if the delivery solution is a partially supplied by this carrier. 
+                                    - name: lineItemIds  | type: Array<string> | description:  Line items that the delivery solution is for. 
+                                - name: deliveryCarrier  | type: Carrier | description:  The delivery option's carrier details, could be multiple if the delivery option is a combination of multiple carriers 
+                                    - name: appId  | type: string | description:  The carrier app id 
+                                    - name: code  | type: string | description:  Unique code that acts as an GUID for a shipping rate. For example, `"usps_std_overnight"`. 
+                                - name: deliveryRegion  | type: Region | description:  The delivery region that are relevant for this delivery solution. 
+                                    - name: _id  | type: string | description:  The delivery region id. 
+                                    - name: name  | type: string | description:  The delivery region name. 
+                          - name: partial  | type: boolean | description:  If the delivery solution is a partial and doesn't apply to all items. 
+                      - name: shippingDestination  | type: AddressWithContact | description:  Shipping address and contact details. 
+                  - name: taxExemptGroupId  | type: string | description:  Tax exempt group GUID to use for tax exemptions. 
+          - 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>
+</ecom_checkout_onCheckoutCompleted>

package/dist/docs-output/api-docs/ecom-checkout-onCheckoutCreated-doc.txt

@@ -0,0 +1,150 @@
+<ecom_checkout_onCheckoutCreated>
+<description>
+# This is a Webhook method
+
+# Method name:
+
+ecom.checkout.onCheckoutCreated(handler: OnCheckoutCreatedHandler)
+
+# Method Link:
+
+https://dev.wix.com/docs/sdk/backend-modules/ecom/checkout/on-checkout-created
+
+# Method Description:
+
+Triggered when a checkout is created.
+
+
+</description>
+<usage>
+import { checkout } from "@wix/ecom";
+
+   checkout.onCheckoutCreated((event) => {
+     // handle your event here
+   });
+   
+</usage>
+<type_definition>
+```
+Method: ecom.checkout.onCheckoutCreated(handler)
+Description: Triggered when a checkout is created.
+Method parameters:
+  param name:  handler | type: OnCheckoutCreatedHandler | description:  none 
+      - name: event  | type: CheckoutCreatedEnvelope | description:  none 
+          - name: entity  | type: Checkout | description:  none 
+              - name: additionalFees  | type: Array<AdditionalFee> | description:  Additional Fees. 
+                    - name: code  | type: string | description:  Additional fee's unique code (or GUID) for future processing. 
+                    - name: lineItemIds  | type: Array<string> | description:  Optional - Line items associated with this additional fee. If no `lineItemIds` are provided, the fee will be associated with the whole cart/checkout/order. 
+                    - name: name  | type: string | description:  Translated additional fee's name. 
+                    - name: price  | type: MultiCurrencyPrice | description:  Additional fee's price. 
+                        - name: amount  | type: string | description:  Amount. 
+                    - name: priceAfterTax  | type: MultiCurrencyPrice | description:  Additional fee's price after tax. 
+                    - name: priceBeforeTax  | type: MultiCurrencyPrice | description:  Additional fee's price before tax. 
+                    - name: providerAppId  | type: string | description:  Provider's app id. 
+                    - name: source  | type: AdditionalFeeSource | description:  the source the additional fee was added from 
+                        enum: 
+                             ITEM: The additional fee was added on the item either via the catalog or on custom line item
+                             MANUAL: The additional fee was added manually on the request
+                             SERVICE_PLUGIN: The additional fee was added by an additional fee service plugin
+                             SHIPPING: The additional fee was added by the shipping provider
+                           UNKNOWN_ADDITIONAL_FEE_SOURCE
+                    - name: taxDetails  | type: ItemTaxFullDetails | description:  Tax details. 
+                        - name: taxRate  | type: string | description:  Tax rate %, as a decimal point between 0 and 1. 
+                        - name: taxableAmount  | type: MultiCurrencyPrice | description:  Amount for which tax is calculated. 
+                        - name: totalTax  | type: MultiCurrencyPrice | description:  Calculated tax, based on `taxable_amount` and `tax_rate`. 
+                    - name: translatedName  | type: string | description:  The translated name of the additional fee. The translation language is determined by the `languages` field in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope). 
+              - name: billingInfo  | type: AddressWithContact | description:  Billing information. 
+                  - name: address  | type: ApiAddress | description:  Address. 
+                      - name: addressLine1  | type: string | description:  Main address line (usually street name and number). 
+                      - name: addressLine2  | type: string | description:  Free text providing more detailed address info. Usually contains apt, suite, floor. 
+                      - name: city  | type: string | description:  City name. 
+                      - name: country  | type: string | description:  Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format. 
+                      - name: location  | type: AddressLocation | description:  Geocode object containing latitude and longitude coordinates. 
+                          - name: latitude  | type: number | description:  Address latitude. 
+                          - name: longitude  | type: number | description:  Address longitude. 
+                      - name: postalCode  | type: string | description:  Postal or zip code. 
+                      - name: streetAddress  | type: StreetAddress | description:  Street address. 
+                          - name: name  | type: string | description:  Street name. 
+                          - name: number  | type: string | description:  Street number. 
+                      - name: subdivision  | type: string | description:  Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format. 
+                  - name: contactDetails  | type: FullAddressContactDetails | description:  Contact details. 
+                      - name: company  | type: string | description:  Company name. 
+                      - name: firstName  | type: string | description:  First name. 
+                      - name: lastName  | type: string | description:  Last name. 
+                      - name: phone  | type: string | description:  Phone number. 
+                      - name: vatId  | type: CommonVatId | description:  Tax information (for Brazil only). If GUID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. 
+                          - name: _id  | type: string | description:  Customer's tax GUID. 
+                          - name: type  | type: CommonVatType | description:  Tax type.  Supported values: + `CPF`: for individual tax payers + `CNPJ`: for corporations 
+                              enum: 
+                                   CNPJ: CNPJ - for corporations
+                                   CPF: CPF - for individual tax payers.
+                                 UNSPECIFIED
+              - name: businessLocationId  | type: string | description:  The business location GUID associated with the checkout.  To learn more, see the Locations API. 
+              - name: buyerInfo  | type: BuyerInfo | description:  Buyer information. 
+                  - name: email  | type: string | description:  Buyer email address. 
+                  - ONE-OF: 
+                    - name: memberId  | type: string | description:  Member GUID (if site visitor is a site member). 
+                    - name: visitorId  | type: string | description:  Visitor GUID (if site visitor is **not** a member). 
+              - name: buyerNote  | type: string | description:  [Buyer note](https://support.wix.com/en/article/collecting-and-viewing-buyer-notes) left by the customer. 
+              - name: cartId  | type: string | description:  Cart GUID that this checkout was created from. Empty if this checkout wasn't created from a cart. 
+              - name: customContentReference  | type: CustomContentReference | description:  Reference GUIDs for the app and component providing custom checkout page content.  To access and manage custom checkout page content, your app must have the permission scope named "Manage eCommerce - Admin Permissions". Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions). 
+                  - name: appId  | type: string | description:  GUID of the app providing the content.  You can get your app's GUID from its page in the [app dashboard](https://dev.wix.com/dc3/my-apps/). 
+                  - name: componentId  | type: string | description:  GUID of the component within the app it belongs to.  You can get your component's GUID from its page in the [app dashboard](https://dev.wix.com/dc3/my-apps/). 
+              - name: customFields  | type: Array<CustomField> | description:  Custom fields. 
+                    - name: title  | type: string | description:  Custom field title. 
+                    - name: translatedTitle  | type: string | description:  Translated custom field title. 
+                    - name: value  | type: any | description:  Custom field value. 
+              - name: customSettings  | type: CustomSettings | description:  Additional settings for customization of the checkout process.  > **Notes:** > * Custom settings can only be set when creating a checkout. > * To access and manage custom checkout page content, your app must have the permission scope named "Manage eCommerce - Admin Permissions". Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions). 
+                  - name: disabledManualPayment  | type: boolean | description:  Whether to disable manual payment option for this checkout.  Default: `false` 
+                  - name: disabledPolicyAgreementCheckbox  | type: boolean | description:  Whether to disable policy agreement checkout in the checkout page  Default: `false` 
+                  - name: lockCouponCode  | type: boolean | description:  Whether to restrict the option to add or remove a coupon code on the checkout page.  Default: `false` 
+                  - name: lockGiftCard  | type: boolean | description:  Whether to restrict the option to add or remove a gift card on the checkout page.  Default: `false` 
+              - name: extendedFields  | type: ExtendedFields | description:  Custom field data for the checkout object.  [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the app dashboard before they can be accessed with API calls. 
+                  - name: namespaces  | type: Record<string, undefined> | description:  Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured.  You can only access fields for which you have the appropriate permissions.  Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields). 
+              - name: externalReference  | type: ExternalReference | description:  References to an external app and resource associated with this checkout. Used for integration and tracking across different platforms. 
+                  - name: appId  | type: string | description:  GUID of the app associated with the purchase flow. For example, the Wix Pay Links app GUID. 
+                  - name: resourceId  | type: string | description:  Reference to an external resource GUID. Used to link the purchase flow to a specific entity in an external system. For example, a Wix Pay Link GUID. 
+              - name: membershipOptions  | type: MembershipOptions | description:  Memberships to apply when creating the order. 
+                  - name: selectedMemberships  | type: SelectedMemberships | description:  Selected membership to apply to this checkout. 
+                      - name: memberships  | type: Array<SelectedMembership> | description:  Selected memberships. 
+                            - name: _id  | type: string | description:  Membership GUID. 
+                            - name: appId  | type: string | description:  GUID of the app providing this payment option. 
+                            - name: lineItemIds  | type: Array<string> | description:  IDs of the line items this membership applies to. 
+              - name: shippingInfo  | type: ShippingInfo | description:  Shipping information. 
+                  - name: selectedCarrierServiceOption  | type: SelectedCarrierServiceOption | description:  Selected option out of the options allowed for the `region`. 
+                      - name: carrierId  | type: string | description:  This carrier's unique GUID 
+                      - name: code  | type: string | description:  Unique identifier of selected option. For example, "usps_std_overnight". 
+                      - name: deliveryAllocations  | type: Array<DeliveryAllocation> | description:  Delivery solution allocations to different delivery carriers and delivery regions 
+                            - name: applicableLineItems  | type: ApplicableLineItems | description:  Populated if the delivery solution is a partially supplied by this carrier. 
+                                - name: lineItemIds  | type: Array<string> | description:  Line items that the delivery solution is for. 
+                            - name: deliveryCarrier  | type: Carrier | description:  The delivery option's carrier details, could be multiple if the delivery option is a combination of multiple carriers 
+                                - name: appId  | type: string | description:  The carrier app id 
+                                - name: code  | type: string | description:  Unique code that acts as an GUID for a shipping rate. For example, `"usps_std_overnight"`. 
+                            - name: deliveryRegion  | type: Region | description:  The delivery region that are relevant for this delivery solution. 
+                                - name: _id  | type: string | description:  The delivery region id. 
+                                - name: name  | type: string | description:  The delivery region name. 
+                      - name: partial  | type: boolean | description:  If the delivery solution is a partial and doesn't apply to all items. 
+                  - name: shippingDestination  | type: AddressWithContact | description:  Shipping address and contact details. 
+              - name: taxExemptGroupId  | type: string | description:  Tax exempt group GUID to use for tax exemptions. 
+          - 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>
+</ecom_checkout_onCheckoutCreated>

package/dist/docs-output/api-docs/ecom-checkout-onCheckoutUpdated-doc.txt

@@ -0,0 +1,150 @@
+<ecom_checkout_onCheckoutUpdated>
+<description>
+# This is a Webhook method
+
+# Method name:
+
+ecom.checkout.onCheckoutUpdated(handler: OnCheckoutUpdatedHandler)
+
+# Method Link:
+
+https://dev.wix.com/docs/sdk/backend-modules/ecom/checkout/on-checkout-updated
+
+# Method Description:
+
+Triggered when a checkout is updated.
+
+
+</description>
+<usage>
+import { checkout } from "@wix/ecom";
+
+   checkout.onCheckoutUpdated((event) => {
+     // handle your event here
+   });
+   
+</usage>
+<type_definition>
+```
+Method: ecom.checkout.onCheckoutUpdated(handler)
+Description: Triggered when a checkout is updated.
+Method parameters:
+  param name:  handler | type: OnCheckoutUpdatedHandler | description:  none 
+      - name: event  | type: CheckoutUpdatedEnvelope | description:  none 
+          - name: entity  | type: Checkout | description:  none 
+              - name: additionalFees  | type: Array<AdditionalFee> | description:  Additional Fees. 
+                    - name: code  | type: string | description:  Additional fee's unique code (or GUID) for future processing. 
+                    - name: lineItemIds  | type: Array<string> | description:  Optional - Line items associated with this additional fee. If no `lineItemIds` are provided, the fee will be associated with the whole cart/checkout/order. 
+                    - name: name  | type: string | description:  Translated additional fee's name. 
+                    - name: price  | type: MultiCurrencyPrice | description:  Additional fee's price. 
+                        - name: amount  | type: string | description:  Amount. 
+                    - name: priceAfterTax  | type: MultiCurrencyPrice | description:  Additional fee's price after tax. 
+                    - name: priceBeforeTax  | type: MultiCurrencyPrice | description:  Additional fee's price before tax. 
+                    - name: providerAppId  | type: string | description:  Provider's app id. 
+                    - name: source  | type: AdditionalFeeSource | description:  the source the additional fee was added from 
+                        enum: 
+                             ITEM: The additional fee was added on the item either via the catalog or on custom line item
+                             MANUAL: The additional fee was added manually on the request
+                             SERVICE_PLUGIN: The additional fee was added by an additional fee service plugin
+                             SHIPPING: The additional fee was added by the shipping provider
+                           UNKNOWN_ADDITIONAL_FEE_SOURCE
+                    - name: taxDetails  | type: ItemTaxFullDetails | description:  Tax details. 
+                        - name: taxRate  | type: string | description:  Tax rate %, as a decimal point between 0 and 1. 
+                        - name: taxableAmount  | type: MultiCurrencyPrice | description:  Amount for which tax is calculated. 
+                        - name: totalTax  | type: MultiCurrencyPrice | description:  Calculated tax, based on `taxable_amount` and `tax_rate`. 
+                    - name: translatedName  | type: string | description:  The translated name of the additional fee. The translation language is determined by the `languages` field in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope). 
+              - name: billingInfo  | type: AddressWithContact | description:  Billing information. 
+                  - name: address  | type: ApiAddress | description:  Address. 
+                      - name: addressLine1  | type: string | description:  Main address line (usually street name and number). 
+                      - name: addressLine2  | type: string | description:  Free text providing more detailed address info. Usually contains apt, suite, floor. 
+                      - name: city  | type: string | description:  City name. 
+                      - name: country  | type: string | description:  Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format. 
+                      - name: location  | type: AddressLocation | description:  Geocode object containing latitude and longitude coordinates. 
+                          - name: latitude  | type: number | description:  Address latitude. 
+                          - name: longitude  | type: number | description:  Address longitude. 
+                      - name: postalCode  | type: string | description:  Postal or zip code. 
+                      - name: streetAddress  | type: StreetAddress | description:  Street address. 
+                          - name: name  | type: string | description:  Street name. 
+                          - name: number  | type: string | description:  Street number. 
+                      - name: subdivision  | type: string | description:  Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format. 
+                  - name: contactDetails  | type: FullAddressContactDetails | description:  Contact details. 
+                      - name: company  | type: string | description:  Company name. 
+                      - name: firstName  | type: string | description:  First name. 
+                      - name: lastName  | type: string | description:  Last name. 
+                      - name: phone  | type: string | description:  Phone number. 
+                      - name: vatId  | type: CommonVatId | description:  Tax information (for Brazil only). If GUID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. 
+                          - name: _id  | type: string | description:  Customer's tax GUID. 
+                          - name: type  | type: CommonVatType | description:  Tax type.  Supported values: + `CPF`: for individual tax payers + `CNPJ`: for corporations 
+                              enum: 
+                                   CNPJ: CNPJ - for corporations
+                                   CPF: CPF - for individual tax payers.
+                                 UNSPECIFIED
+              - name: businessLocationId  | type: string | description:  The business location GUID associated with the checkout.  To learn more, see the Locations API. 
+              - name: buyerInfo  | type: BuyerInfo | description:  Buyer information. 
+                  - name: email  | type: string | description:  Buyer email address. 
+                  - ONE-OF: 
+                    - name: memberId  | type: string | description:  Member GUID (if site visitor is a site member). 
+                    - name: visitorId  | type: string | description:  Visitor GUID (if site visitor is **not** a member). 
+              - name: buyerNote  | type: string | description:  [Buyer note](https://support.wix.com/en/article/collecting-and-viewing-buyer-notes) left by the customer. 
+              - name: cartId  | type: string | description:  Cart GUID that this checkout was created from. Empty if this checkout wasn't created from a cart. 
+              - name: customContentReference  | type: CustomContentReference | description:  Reference GUIDs for the app and component providing custom checkout page content.  To access and manage custom checkout page content, your app must have the permission scope named "Manage eCommerce - Admin Permissions". Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions). 
+                  - name: appId  | type: string | description:  GUID of the app providing the content.  You can get your app's GUID from its page in the [app dashboard](https://dev.wix.com/dc3/my-apps/). 
+                  - name: componentId  | type: string | description:  GUID of the component within the app it belongs to.  You can get your component's GUID from its page in the [app dashboard](https://dev.wix.com/dc3/my-apps/). 
+              - name: customFields  | type: Array<CustomField> | description:  Custom fields. 
+                    - name: title  | type: string | description:  Custom field title. 
+                    - name: translatedTitle  | type: string | description:  Translated custom field title. 
+                    - name: value  | type: any | description:  Custom field value. 
+              - name: customSettings  | type: CustomSettings | description:  Additional settings for customization of the checkout process.  > **Notes:** > * Custom settings can only be set when creating a checkout. > * To access and manage custom checkout page content, your app must have the permission scope named "Manage eCommerce - Admin Permissions". Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions). 
+                  - name: disabledManualPayment  | type: boolean | description:  Whether to disable manual payment option for this checkout.  Default: `false` 
+                  - name: disabledPolicyAgreementCheckbox  | type: boolean | description:  Whether to disable policy agreement checkout in the checkout page  Default: `false` 
+                  - name: lockCouponCode  | type: boolean | description:  Whether to restrict the option to add or remove a coupon code on the checkout page.  Default: `false` 
+                  - name: lockGiftCard  | type: boolean | description:  Whether to restrict the option to add or remove a gift card on the checkout page.  Default: `false` 
+              - name: extendedFields  | type: ExtendedFields | description:  Custom field data for the checkout object.  [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the app dashboard before they can be accessed with API calls. 
+                  - name: namespaces  | type: Record<string, undefined> | description:  Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured.  You can only access fields for which you have the appropriate permissions.  Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields). 
+              - name: externalReference  | type: ExternalReference | description:  References to an external app and resource associated with this checkout. Used for integration and tracking across different platforms. 
+                  - name: appId  | type: string | description:  GUID of the app associated with the purchase flow. For example, the Wix Pay Links app GUID. 
+                  - name: resourceId  | type: string | description:  Reference to an external resource GUID. Used to link the purchase flow to a specific entity in an external system. For example, a Wix Pay Link GUID. 
+              - name: membershipOptions  | type: MembershipOptions | description:  Memberships to apply when creating the order. 
+                  - name: selectedMemberships  | type: SelectedMemberships | description:  Selected membership to apply to this checkout. 
+                      - name: memberships  | type: Array<SelectedMembership> | description:  Selected memberships. 
+                            - name: _id  | type: string | description:  Membership GUID. 
+                            - name: appId  | type: string | description:  GUID of the app providing this payment option. 
+                            - name: lineItemIds  | type: Array<string> | description:  IDs of the line items this membership applies to. 
+              - name: shippingInfo  | type: ShippingInfo | description:  Shipping information. 
+                  - name: selectedCarrierServiceOption  | type: SelectedCarrierServiceOption | description:  Selected option out of the options allowed for the `region`. 
+                      - name: carrierId  | type: string | description:  This carrier's unique GUID 
+                      - name: code  | type: string | description:  Unique identifier of selected option. For example, "usps_std_overnight". 
+                      - name: deliveryAllocations  | type: Array<DeliveryAllocation> | description:  Delivery solution allocations to different delivery carriers and delivery regions 
+                            - name: applicableLineItems  | type: ApplicableLineItems | description:  Populated if the delivery solution is a partially supplied by this carrier. 
+                                - name: lineItemIds  | type: Array<string> | description:  Line items that the delivery solution is for. 
+                            - name: deliveryCarrier  | type: Carrier | description:  The delivery option's carrier details, could be multiple if the delivery option is a combination of multiple carriers 
+                                - name: appId  | type: string | description:  The carrier app id 
+                                - name: code  | type: string | description:  Unique code that acts as an GUID for a shipping rate. For example, `"usps_std_overnight"`. 
+                            - name: deliveryRegion  | type: Region | description:  The delivery region that are relevant for this delivery solution. 
+                                - name: _id  | type: string | description:  The delivery region id. 
+                                - name: name  | type: string | description:  The delivery region name. 
+                      - name: partial  | type: boolean | description:  If the delivery solution is a partial and doesn't apply to all items. 
+                  - name: shippingDestination  | type: AddressWithContact | description:  Shipping address and contact details. 
+              - name: taxExemptGroupId  | type: string | description:  Tax exempt group GUID to use for tax exemptions. 
+          - 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>
+</ecom_checkout_onCheckoutUpdated>