Merge branch 'main' into 2.4.8-develop

Author: jeff-matthews

.github/workflows/github-pages.yml

@@ -1,45 +1,20 @@
----
-name: Github Pages
+name: Deploy Gatsby site to Pages
+
 on: workflow_dispatch
-permissions: {}
-jobs:
-  build-and-deploy:
-    runs-on: ubuntu-latest
-    permissions:
-      actions: read
-      contents: write
-    steps:
-      - uses: actions/checkout@v4
-      - name: Use Setup Node and Install Dependencies Action
-        uses: commerce-docs/devsite-install-action@main
-        with:
-          node-version-file: '.nvmrc'
-          cache-dependency-path: 'yarn.lock'
 
-      - name: Build site
-        run: yarn build
-        env:
-          NODE_OPTIONS: "--max-old-space-size=8192"
-          PREFIX_PATHS: true # works like --prefix-paths flag for 'gatsby build'
-          PATH_PREFIX: ${{ github.event.repository.name }}
-          ADOBE_LAUNCH_SRC: ${{ secrets.AIO_ADOBE_LAUNCH_SRC }}
-          ADOBE_LAUNCH_SRC_INCLUDE_IN_DEVELOPMENT: ${{ secrets.ADOBE_LAUNCH_SRC_INCLUDE_IN_DEVELOPMENT }}
-          REPO_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          REPO_OWNER: ${{ github.event.repository.owner.login }}
-          REPO_NAME: ${{ github.event.repository.name }}
-          REPO_BRANCH: ${{ github.ref_name }}
-          GOOGLE_OAUTH_CLIENT_ID: ${{ secrets.GOOGLE_OAUTH_CLIENT_ID }}
-          GOOGLE_OAUTH_CLIENT_SECRET: ${{ secrets.GOOGLE_OAUTH_CLIENT_SECRET }}
-          GOOGLE_DOCS_TOKEN: ${{ secrets.GOOGLE_DOCS_TOKEN }}
-          GOOGLE_DOCS_FOLDER_ID: ${{ secrets.GOOGLE_DOCS_FOLDER_ID }}
-      - name: Deploy to GH Pages
-        uses: JamesIves/github-pages-deploy-action@v4
-        with:
-          token: ${{ secrets.GITHUB_TOKEN }}
-          branch: gh-pages # The branch the action should deploy to.
-          folder: public # The folder the action should deploy.
-          clean: true # Automatically remove deleted files from deploy branch
-      - name: GH Pages URL
-        id: gh-pages-url
-        run: |
-          echo "View GH-Pages: $(https://${{ github.repository_owner }}.github.io/${{ github.event.repository.name }})"
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+defaults:
+  run:
+    shell: bash
+
+jobs:
+  call-workflow-deploy-to-pages:
+    uses: AdobeDocs/commerce-php/.github/workflows/deploy-to-pages_job.yml@main

.github/workflows/publish.yml

@@ -63,7 +63,7 @@ jobs:
           cache-dependency-path: 'yarn.lock'
 
       - name: Gatsby Cache
-        uses: actions/cache@v3.3.2
+        uses: actions/cache@v4
         with:
           path: |
             public

.github/workflows/stage.yml

@@ -74,7 +74,7 @@
             cache-dependency-path: 'yarn.lock'
 
         - name: Gatsby Cache
-          uses: actions/cache@v3.3.2
+          uses: actions/cache@v4
           with:
             path: |
               public

.github/workflows/test-pull-request.yml

@@ -1,100 +1,12 @@
 ---
-  ###########################
-  ###########################
-  ## Pull request testing ##
-  ###########################
-  ###########################
   name: Validate pull request
 
-  # Documentation:
-  # - Workflow: https://help.github.com/en/articles/workflow-syntax-for-github-actions
-  # - SuperLinter: https://github.com/github/super-linter
-  # - Link validation: https://github.com/remarkjs/remark-validate-links
-  
-  ######################################################
-  # Start the job on a pull request to the main branch #
-  ######################################################
   on: pull_request
 
-  #################################################
-  # Disable all permissions on the workflow level #
-  #################################################
-  permissions: {}
+  permissions:
+    contents: read
+    statuses: write
 
-  ###############
-  # Set the Job #
-  ###############
   jobs:
-    lint:
-      # Set the agent to run on
-      runs-on: ubuntu-latest
-  
-      ############################################
-      # Grant status permission for MULTI_STATUS #
-      ############################################
-      permissions:
-        contents: read
-        statuses: write
-  
-      ##################
-      # Load all steps #
-      ##################
-      steps:
-        ##########################
-        # Checkout the code base #
-        ##########################
-        - name: Checkout Code
-          uses: actions/checkout@v4
-          with:
-            # Full git history is needed to get a proper list of changed files
-            # within `super-linter`
-            fetch-depth: 0
-        - name: Load super-linter configuration
-          run: cat .github/super-linter.env >> "$GITHUB_ENV"
-  
-        ################################
-        # Run Linters against code base #
-        ################################
-        - name: Lint Code Base
-          #
-          # Use full version number to avoid cases when a next
-          # released version is buggy
-          # About slim image: https://github.com/github/super-linter#slim-image
-          uses: super-linter/super-linter/slim@v7.2.0
-          env:
-            GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-            DEFAULT_BRANCH: main
-
-    test:
-      runs-on: ubuntu-latest
-      needs: lint
-      permissions:
-        contents: read
-        statuses: write
-      steps:
-        - uses: actions/checkout@v4
-        - name: Use Setup Node and Install Dependencies Action
-          uses: commerce-docs/devsite-install-action@main
-          with:
-            node-version-file: '.nvmrc'
-            cache-dependency-path: 'yarn.lock'
-  
-        - name: Check links
-          run: yarn test
-
-    build:
-      runs-on: ubuntu-latest
-      needs: test
-      permissions:
-        contents: read
-        statuses: write
-      steps:
-        - uses: actions/checkout@v4
-        - name: Use Setup Node and Install Dependencies Action
-          uses: commerce-docs/devsite-install-action@main
-          with:
-            node-version-file: '.nvmrc'
-            cache-dependency-path: 'yarn.lock'
-  
-        - name: Build site
-          run: yarn build
+    testing:
+      uses: AdobeDocs/commerce-php/.github/workflows/validate-pr_job.yml@main

package.json

@@ -7,7 +7,7 @@
     "url": "https://github.com/AdobeDocs/commerce-webapi"
   },
   "dependencies": {
-    "@adobe/gatsby-theme-aio": "4.14.18",
+    "@adobe/gatsby-theme-aio": "4.14.19",
     "gatsby": "4.22.0",
     "react": "^17.0.2",
     "react-dom": "^17.0.2"

src/data/navigation/sections/graphql.js

@@ -127,6 +127,10 @@ module.exports = [
             title: "Queries",
             path: "/graphql/schema/cart/queries/",
             pages: [
+              {
+                title: "allCartRules",
+                path: "/graphql/schema/cart/queries/all-rules/",
+              },
               {
                 title: "cart",
                 path: "/graphql/schema/cart/queries/cart/",
@@ -443,6 +447,14 @@ module.exports = [
             title: "Queries",
             path: "/graphql/schema/customer/queries/",
             pages: [
+              {
+                title: "allCustomerGroups",
+                path: "/graphql/schema/customer/queries/all-groups/"
+              },
+              {
+                title: "allCustomerSegments",
+                path: "/graphql/schema/customer/queries/all-segments/"
+              },
               {
                 title: "customer",
                 path: "/graphql/schema/customer/queries/customer/",
@@ -459,6 +471,10 @@ module.exports = [
                 title: "customerOrders",
                 path: "/graphql/schema/customer/queries/orders/",
               },
+              {
+                title: "customerSegments",
+                path: "/graphql/schema/customer/queries/segments/"
+              },
               {
                 title: "giftCardAccount",
                 path: "/graphql/schema/customer/queries/giftcard-account/",
@@ -801,6 +817,10 @@ module.exports = [
             title: "Queries",
             path: "/graphql/schema/products/queries/",
             pages: [
+              {
+                title: "allCatalogRules",
+                path: "/graphql/schema/products/queries/all-rules/",
+              },
               {
                 title: "categories",
                 path: "/graphql/schema/products/queries/categories/",
@@ -1249,6 +1269,14 @@ module.exports = [
                 title: "Minicart",
                 path: "/graphql/payment-services-extension/workflows/minicart.md",
               },
+              {
+                title: "Vault a card during a checkout authorization",
+                path: "/graphql/payment-services-extension/workflows/vault-with-purchase.md",
+              },
+              {
+                title: "Vault a credit card without a purchase",
+                path: "/graphql/payment-services-extension/workflows/vault-without-purchase.md",
+              },
               {
                 title: "Vaulted card",
                 path: "/graphql/payment-services-extension/workflows/vaulted-card.md",

src/pages/_images/graphql/payment-services-paypal-vault.svg renamed to src/pages/_images/graphql/payment-services-paypal-vaulted-card.svg

@@ -0,0 +1,108 @@
+---
+title: Vault a card during a checkout authorization
+description: Learn how to vault a credit card during a typical checkout authorization.
+keywords:
+  - GraphQL
+  - Payments
+---
+
+# Vault a card during a checkout authorization
+
+These steps describe the flow of requests and responses required to [vault a credit card](https://experienceleague.adobe.com/en/docs/commerce-merchant-services/payment-services/payments-checkout/vaulting#vaulting-a-payment-method-during-checkout) during a typical checkout authorization with Payment Services enabled.
+
+The following conditions must be true to vault a card during checkout:
+
+* You must have installed [Payment Services for Adobe Commerce](https://commercemarketplace.adobe.com/magento-payment-services.html) 2.10.0 or higher.
+* The customer must be logged in.
+
+## Workflow
+
+![Payment Services sequence diagram](../../../_images/graphql/payment-services-vault-with-purchase.svg)
+
+1. Run the [`getPaymentConfig`](../../payment-services-extension/queries/get-payment-config.md) query to fetch the payment configuration needed to render details of hosted fields.
+
+1. Commerce returns the payment configuration information.
+
+1. Run the [`setPaymentMethodOnCart`](../../schema/cart/mutations/set-payment-method.md) mutation to [set the payment method](../../tutorials/checkout/set-payment-method.md).
+
+1. Adobe Commerce returns a `Cart` object.
+
+1. Run the [`createPaymentOrder`](../../payment-services-extension/mutations/create-payment-order.md) mutation with `vaultIntent` set to `true` to begin the authorization process.
+
+1. Commerce forwards the request to PayPal.
+
+1. PayPal returns an `id` value.
+
+1. Adobe Commerce generates a `order_id` and forwards the value in the `mp_order_id` field and the PayPal response in the `id` field.
+
+1. Run [`setPaymentMethodOnCart`](../../schema/cart/mutations/set-payment-method.md) again with [`is_active_payment_token_enabler`](https://developer.adobe.com/commerce/webapi/graphql/payment-services-extension/workflows/checkout/#setpaymentmethodoncartinput-object) set to `true`. This indicates whether a customer-entered credit/debit card should be tokenized for later usage.
+
+1. Adobe Commerce returns a token.
+
+1. (Optional) If hosted fields and the Signifyd integration are enabled, run the [`getPaymentOrder`](../../payment-services-extension/queries/get-payment-order.md) query.
+
+1. (Optional) Adobe Commerce returns details about the payment order.
+
+1. Run the [`placeOrder`](../../schema/cart/mutations/place-order.md) mutation.
+
+1. Commerce sends an authorization request to PayPal.
+
+1. PayPal returns the result to Commerce.
+
+1. Commerce creates an order.
+
+1. Paypal returns a vault token.
+
+1. Commerce stores the vault token for the vaulted card.
+
+## Additional information
+
+It is only possible to vault configuration details for hosted fields. See [`getPaymentConfig`](../../payment-services-extension/queries/get-payment-config.md) query for more information.
+
+### `setPaymentMethodOnCart` mutation example
+
+The following example shows the `setPaymentMethodOnCart` mutation with the attribute `is_active_payment_token_enabler` set to `true`.
+
+**Request:**
+
+```graphql
+mutation {
+    setPaymentMethodOnCart ( input: {
+      cart_id: "uocGxUi5H97XFAMhY3s66q4aFYG3Bmdr",
+      payment_method: {
+        code: "payment_services_paypal_hosted_fields",
+        payment_services_paypal_hosted_fields: {
+          payment_source: "cc",
+          payments_order_id: "mp-order-a4babd34-13d3-4ac0-b1b0-109bb7be1574",
+          paypal_order_id: "9R90936863877801D",
+          is_active_payment_token_enabler: true
+        }
+      }
+    }
+    ) {
+       cart {
+         id
+         selected_payment_method {
+           code
+         }
+       }
+    }
+  } 
+```
+
+**Response:**
+
+```json
+{
+  "data": {
+    "setPaymentMethodOnCart": {
+      "cart": {
+        "id": "uocGxUi5H97XFAMhY3s66q4aFYG3Bmdr",
+        "selected_payment_method": {
+          "code": "payment_services_paypal_hosted_fields"
+        }
+      }
+    }
+  }
+}
+```