Merge branch '2.4.1-develop' into kh_graphql-giftcard-idv2

Author: keharper

src/_data/toc/graphql.yml

@@ -172,6 +172,10 @@ pages:
         - label: createCustomer mutation
           url: /graphql/mutations/create-customer.html
 
+        - label: createCustomerV2 mutation
+          url: /graphql/mutations/create-customer-v2.html
+          exclude_versions: ["2.3"]
+
         - label: createCustomerAddress mutation
           url: /graphql/mutations/create-customer-address.html
 
@@ -243,13 +247,13 @@ pages:
         - label: sendEmailToFriend mutation
           url: /graphql/mutations/send-email-to-friend.html
 
-        - label: subscribeEmailToNewsletter mutation
-          url: /graphql/mutations/subscribe-email-to-newsletter.html
-          exclude_versions: ["2.3"]
-
         - label: setBillingAddressesOnCart mutation
           url: /graphql/mutations/set-billing-address.html
 
+        - label: setGiftOptionsOnCart mutation
+          url: /graphql/mutations/set-gift-options.html
+          exclude_versions: ["2.3"]
+
         - label: setGuestEmailOnCart mutation
           url: /graphql/mutations/set-guest-email.html
 
@@ -265,12 +269,24 @@ pages:
         - label: setShippingMethodsOnCart mutation
           url: /graphql/mutations/set-shipping-method.html
 
+        - label: subscribeEmailToNewsletter mutation
+          url: /graphql/mutations/subscribe-email-to-newsletter.html
+          exclude_versions: ["2.3"]
+
         - label: updateCartItems mutation
           url: /graphql/mutations/update-cart-items.html
 
         - label: updateCustomer mutation
           url: /graphql/mutations/update-customer.html
 
+        - label: updateCustomerEmail mutation
+          url: /graphql/mutations/update-customer-email.html
+          exclude_versions: ["2.3"]
+
+        - label: updateCustomerV2 mutation
+          url: /graphql/mutations/update-customer-v2.html
+          exclude_versions: ["2.3"]
+
         - label: updateCustomerAddress mutation
           url: /graphql/mutations/update-customer-address.html
 

src/_includes/graphql/cart-object-24.md

@@ -5,14 +5,18 @@ Attribute |  Data Type | Description
 `applied_gift_cards` | [[`AppliedGiftCard`]][AppliedGiftCard] | An array of `AppliedGiftCard` objects. An `AppliedGiftCard` object contains the `code` text attribute, which specifies the gift card code. `applied_gift_cards` is a Commerce-only attribute, defined in the GiftCardAccountGraphQl module
 `applied_reward_points`| [`RewardPointsAmount`][RewardPointsAmount] | The amount of reward points applied to the cart
 `applied_store_credit` | [`AppliedStoreCredit`][AppliedStoreCredit] | Contains store credit information applied to the cart. `applied_store_credit` is a Commerce-only attribute, defined in the CustomerBalanceGraphQl module
+`available_gift_wrappings` | [GiftWrapping]! | The list of available gift wrapping options for the cart
 `available_payment_methods` | [[AvailablePaymentMethod]][AvailablePaymentMethod] | Available payment methods
 `billing_address` | [BillingCartAddress][BillingCartAddress] | Contains the billing address specified in the customer's cart
 `email` | String | The customer's email address
 `gift_message` | [GiftMessage][GiftMessage] | A gift message added to the cart
+`gift_receipt_included` | Boolean! | Indicates if the customer requested a gift receipt for the cart
+`gift_wrapping` | GiftWrapping | The selected gift wrapping for the cart
 `id` | ID! | The ID of the cart
 `is_virtual` | Boolean! | Indicates whether the cart contains only virtual products
 `items` | [[CartItemInterface]][CartItemInterface] | Contains the items in the customer's cart
 `prices` | [CartPrices][CartPrices] | Contains subtotals and totals
+`printed_card_included` | Boolean! | Indicates if the customer requested a printed card for the cart
 `selected_payment_method` | [SelectedPaymentMethod][SelectedPaymentMethod] | Selected payment method
 `shipping_addresses` | [[ShippingCartAddress]][ShippingCartAddress]! | Contains one or more shipping addresses
 `total_quantity` | Float! | Total Quantity of products in the cart

src/_includes/graphql/customer-orders-output.md

@@ -47,14 +47,18 @@ Attribute | Data type | Description
 `created_at` | String | Deprecated. Use the `order_date` attribute instead
 `credit_memos` | [[CreditMemo](#CreditMemo)] | Contains a list of credit memos for the order
 `grand_total` | Float  | Deprecated. Use the `totals.grand_total` attribute instead
+`gift_message` | [GiftMessage](#GiftMessage) | The entered gift message for the order
+`gift_receipt_included` | Boolean! | Indicates if the customer requested a gift receipt for the order
+`gift_wrapping` | [GiftWrapping](#GiftWrapping) | The selected gift wrapping for the order
 `id` | ID! | Unique identifier for the order
 `increment_id` | String | Deprecated. Use the `id` attribute instead
 `invoices` | [[Invoice](#Invoice)]! | Contains a list of invoices for the order
 `items` | [[OrderItemInterface](#OrderItemInterface)] | An array containing the items purchased in this order
 `number` | String! | The order number
 `order_date` | String! | The date the order was placed
 `order_number` | String! | Deprecated. Use the `number` attribute instead
-`payment_methods` | [[OrderPaymentMethod](#OrderPaymentMethod)] | Payment details for the order
+`payment_methods` | [[PaymentMethod](#PaymentMethod)] | Payment details for the order
+`printed_card_included` | Boolean! | Indicates if the customer requested a printed card for the order
 `shipments` | [[OrderShipment](#OrderShipment)] | Shipment list for the order
 `shipping_address` | [OrderAddress](#OrderAddress) | Shipping address for the order
 `shipping_method` | String | Shipping method for the order
@@ -227,6 +231,14 @@ Attribute | Data type | Description
 --- | --- | ---
 `gift_card` | [GiftCardItem](#GiftCardItem) | Selected gift card properties for a shipped item
 
+### GiftMessage attributes {#GiftMessage}
+
+{% include graphql/gift-message.md %}
+
+### GiftWrapping attributes {#GiftWrapping}
+
+{% include graphql/gift-wrapping.md %}
+
 #### Invoice attributes {#Invoice}
 
 The `Invoice` object provides details about a customer invoice.
@@ -358,16 +370,6 @@ Attribute | Data type | Description
 `label` | String! | The name of the option
 `value` | String! | The value of the option
 
-#### OrderPaymentMethod attributes {#OrderPaymentMethod}
-
-The OrderPaymentMethod data type contains details about the payment method used to pay for the order.
-
-Attribute | Data type | Description
---- | --- | ---
-`additional_data` | [[KeyValue](#KeyValue)] | Additional data per payment method type
-`name` | String! | The label that describes the payment method
-`type` | String! | The payment method code that indicates how the order was paid for
-
 #### OrderShipment attributes {#OrderShipment}
 
 Attribute | Data type | Description
@@ -393,6 +395,16 @@ Attribute | Data type | Description
 `total_shipping` | Money! | The shipping costs for the order
 `total_tax` | Money! | The amount of tax applied to the order
 
+#### PaymentMethod attributes {#PaymentMethod}
+
+The PaymentMethod data type contains details about the payment method used to pay for the order.
+
+Attribute | Data type | Description
+--- | --- | ---
+`additional_data` | [[KeyValue](#KeyValue)] | Additional data per payment method type
+`name` | String! | The label that describes the payment method
+`type` | String! | The payment method code that indicates how the order was paid for
+
 #### RewardPoints attributes {#RewardPoints}
 
 The `RewardPoints` object provides details about the customer's reward points balance,  history, and related information.

src/_includes/graphql/gift-message.md

@@ -0,0 +1,7 @@
+The `GiftMessage` object can contain the following attributes.
+
+Attribute |  Data Type | Description
+--- | --- | ---
+`from` | String! | The name of the gift sender
+`message` | String! | The text of the gift message
+`to` | String! | The name of the gift recipient

src/_includes/graphql/gift-wrapping.md

@@ -0,0 +1,17 @@
+The `GiftWrapping` object can contain the following attributes.
+
+Attribute |  Data Type | Description
+--- | --- | ---
+`design` | String! | The name of the gift wrapping design
+`id` | ID! | The unique identifier for the gift wrapping option
+`image` | [GiftWrappingImage](#GiftWrappingImage) | The preview image for the gift wrapping option
+`price` | Money! | The price of the gift wrapping option
+
+### GiftWrappingImage object {#GiftWrappingImage}
+
+The `GiftWrappingImage` object must contain the following attributes.
+
+Attribute |  Data Type | Description
+--- | --- | ---
+`label` | String! | The label of the gift wrapping preview image
+`url` | String! | The URL of the gift wrapping preview image

src/guides/v2.4/graphql/mutations/create-customer-v2.md

@@ -0,0 +1,101 @@
+---
+group: graphql
+title: createCustomerV2 mutation
+---
+
+The `createCustomerV2` mutation creates a customer account. Use the [`createCustomerAddress` mutation]({{page.baseurl}}/graphql/mutations/create-customer-address.html) to complete the customer profile and define billing and shipping addresses.
+
+The `createCustomerV2` mutation replaces the `createCustomer` mutation as the means to create a customer account. The input objects differ between these two mutations. The `createCustomer` mutation required the `CustomerInput` object, as did the `updateCustomer` mutation. The attributes required for creating a customer are different than those for updating a customer, but you could not determine this by looking at the schema. The `createCustomerV2` mutation requires the `CustomerCreateInput` object, which it does not share with the [`updateCustomerV2` mutation]({{page.baseurl}}/graphql/mutations/update-customer-v2.html).
+
+## Syntax
+
+`mutation: {createCustomerV2(input: CustomerCreateInput!) {CustomerOutput}}`
+
+## Example usage
+
+The following call creates a new customer.
+
+**Request:**
+
+```graphql
+mutation {
+  createCustomerV2(
+    input: {
+      firstname: "Bob"
+      lastname: "Loblaw"
+      email: "[email protected]"
+      password: "b0bl0bl@w"
+      is_subscribed: true
+    }
+  ) {
+    customer {
+      firstname
+      lastname
+      email
+      is_subscribed
+    }
+  }
+}
+```
+
+**Response:**
+
+```json
+{
+  "data": {
+    "createCustomer": {
+      "customer": {
+        "firstname": "Bob",
+        "lastname": "Loblaw",
+        "email": "[email protected]",
+        "is_subscribed": true
+      }
+    }
+  }
+}
+```
+
+## Input attributes
+
+The following table lists the attributes you can use as input for the `createCustomerV2` mutation.
+
+Attribute |  Data Type | Description
+--- | --- | ---
+`date_of_birth` | String | The customer’s date of birth
+`dob` | String | Deprecated. Use `date_of_birth` instead. The customer’s date of birth
+`email` | String! | The customer’s email address
+`firstname` | String! | The customer’s first name
+`gender` | Int | The customer's gender (Male - 1, Female - 2)
+`is_subscribed` | Boolean | Indicates whether the customer subscribes to the store's newsletter
+`lastname` | String! | The customer’s last name
+`middlename` | String | The customer’s middle name
+`password` | String | The customer's password
+`prefix` | String | An honorific, such as Dr., Mr., or Mrs.
+`suffix` | String | A value such as Sr., Jr., or III
+`taxvat` | String | The customer’s Tax/VAT number (for corporate customers)
+
+## Output attributes
+
+The `CustomerOutput` object contains the `Customer` object.
+
+The following table lists the top-level attributes of the `customer` object. See the [`customer` query]({{page.baseurl}}/graphql/queries/customer.html) for complete details about this object.
+
+{% include graphql/customer-output-24.md %}
+
+## Errors
+
+Error | Description
+--- | ---
+`A customer with the same email address already exists in an associated website.` | The email provided in the `input`.`email` argument belongs to an existing customer.
+`"Email" is not a valid email address.` | The value provided in the `input`.`email` argument has an invalid format.
+`Field CustomerInput.email of required type String! was not provided` | The `input`.`email` argument was omitted.
+`Field "xxx" is not defined by type CustomerInput.` | The `input`.`xxx` argument is undefined.
+`Required parameters are missing: First Name` | The `input`.`firstname` argument was omitted or contains an empty value.
+
+## Related topics
+
+*  [customer query]({{page.baseurl}}/graphql/queries/customer.html)
+*  [updateCustomerV2 mutation]({{page.baseurl}}/graphql/mutations/update-customer-v2.html)
+*  [createCustomerAddress mutation]({{page.baseurl}}/graphql/mutations/create-customer-address.html)
+*  [updateCustomerAddress mutation]({{page.baseurl}}/graphql/mutations/update-customer-address.html)
+*  [deleteCustomerAddress mutation]({{page.baseurl}}/graphql/mutations/delete-customer-address.html)

src/guides/v2.4/graphql/mutations/create-customer.md

@@ -3,6 +3,9 @@ group: graphql
 title: createCustomer mutation
 ---
 
+{:.bs-callout-warning}
+The `createCustomer` mutation has been deprecated. Use the [createCustomerV2]({{page.baseurl}}/graphql/mutations/create-customer-v2.html) mutation instead.
+
 Use the `createCustomer` mutation to create a new customer.
 
 To return or modify information about a customer, Magento recommends you use customer tokens in the header of your GraphQL calls. However, you also can use [session authentication]({{ page.baseurl }}/get-started/authentication/gs-authentication-session.html).