@wix/ditto-codegen-public 1.0.169 → 1.0.171

package/dist/docs-output/api-docs/ecom-cart-createCheckout-doc.txt

@@ -29,7 +29,7 @@ undefined
 
 # Method Code Examples:
 
-## Create a checkout from a cart 
+## Create a checkout from a cart
 
 ```javascript
 /**************************************
@@ -87,12 +87,6 @@ myCreateCheckoutFunction(cartId, options)
    console.error(error);
    // Handle the error
  });
-
-/* Promise resolves to:
-*
-* {"checkoutId": "a43420aa-986b-456a-a2f7-7ea5c80e9007"}
-*
-*/
 ```
 
 
@@ -103,22 +97,22 @@ Method: ecom.cart.createCheckout(_id, options)
 Description: Creates a checkout from a cart.  If a checkout for the specified cart already exists, that checkout is updated with any new information from the cart.  > **Note:** `channelType` is a required field.
 Method parameters:
   param name:  _id | type: string | description:  Cart GUID. | required: true
-  param name:  options | type: CreateCheckoutOptions | description:  Checkout creation options. 
-      - name: billingAddress  | type: Address | description:  Billing address. Used for calculating tax if all the items in the cart are not shippable. 
-          - 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: channelType  | type: ChannelType | description:  __Required.__ Sales channel type. 
-          enum: 
+  param name:  options | type: CreateCheckoutOptions | description:  Checkout creation options.
+      - name: billingAddress  | type: Address | description:  Billing address. Used for calculating tax if all the items in the cart are not shippable.
+          - 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: channelType  | type: ChannelType | description:  __Required.__ Sales channel type.
+          enum:
                AMAZON: [Amazon shop](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-amazon-shop).
                BACKOFFICE_MERCHANT: Wix merchant backoffice.
                CLASS_PASS: [ClassPass sales channel](https://support.wix.com/en/article/wix-bookings-letting-clients-book-your-services-with-classpass).
@@ -136,13 +130,13 @@ Method parameters:
                WISH: Wish sales channel.
                WIX_APP_STORE: [Wix Owner app](https://support.wix.com/article/wix-owner-app-an-overview).
                WIX_INVOICES: Wix Invoices app in [your dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Finvoices/settings/general-settings)
-      - name: email  | type: string | description:  Required when setting a billing or shipping address if the site visitor isn't logged in. 
-      - name: selectedShippingOption  | type: SelectedShippingOption | description:  Selected shipping option. 
-          - name: carrierId  | type: string | description:  Carrier GUID. 
-          - name: code  | type: string | description:  Selected shipping option code. For example, "usps_std_overnight". 
-      - name: shippingAddress  | type: Address | description:  Shipping address. Used for calculating tax and shipping (when applicable). 
+      - name: email  | type: string | description:  Required when setting a billing or shipping address if the site visitor isn't logged in.
+      - name: selectedShippingOption  | type: SelectedShippingOption | description:  Selected shipping option.
+          - name: carrierId  | type: string | description:  Carrier GUID.
+          - name: code  | type: string | description:  Selected shipping option code. For example, "usps_std_overnight".
+      - name: shippingAddress  | type: Address | description:  Shipping address. Used for calculating tax and shipping (when applicable).
 Return type: PROMISE<CreateCheckoutResponse>
-      - name: checkoutId  | type: string | description:  The newly created checkout's GUID. 
+      - name: checkoutId  | type: string | description:  The newly created checkout's GUID.
 Possible Errors:
   HTTP Code: 428 | Status Code: FAILED_PRECONDITION | Application Code: CUSTOM_LINE_ITEM_MUST_HAVE_EXACTLY_ONE_PROPERTIES_TYPE
   HTTP Code: 428 | Status Code: FAILED_PRECONDITION | Application Code: CUSTOM_LINE_ITEM_ONLY_ACCEPTS_PAYMENTS_ONLINE_AND_OFFLINE
@@ -152,4 +146,4 @@ Possible Errors:
 
 ```
 </type_definition>
-</ecom_cart_createCheckout>
+</ecom_cart_createCheckout>