@salesforce/b2c-tooling-sdk 2.4.0 → 2.5.0

package/node_modules/@salesforce/b2c-api-schemas/scapi/shopper/consents/v1.json

@@ -2,7 +2,8 @@
   "openapi": "3.0.3",
   "info": {
     "title": "Consents",
-    "version": "1.1.4",
+    "description": "[Download API specification](https://developer.salesforce.com/static/commercecloud/commerce-api/consents/consents-oas-v1-public.yaml)\n\n# API Overview\n\nUse the Consents Admin API to manage customer consent subscription preferences for marketing communications across multiple channels. This API provides complete CRUD (Create, Read, Update, Delete) operations for subscription management, with support for rich text markup in subscription titles and subtitles.\n\n## Authentication & Authorization\n\nFor resource access, you must use a client ID and client secret from Account Manager to request an access token. The access token is used as a bearer token and added to the Authorization header of your API request.\n\nYou must include one of the following OAuth scopes in the client ID used to generate the token:\n\n- `sfcc.consents`: Required for reading subscription data (GET operations)\n- `sfcc.consents.rw`: Required for creating, updating, and deleting subscription data (POST, PUT, PATCH, DELETE operations)\n\nFor a full list of permissions, see the [Authorization Scopes Catalog.](https://developer.salesforce.com/docs/commerce/commerce-api/guide/auth-z-scope-catalog.html)\n\nFor detailed setup instructions, see the [Authorization for Admin APIs guide. ](https://developer.salesforce.com/docs/commerce/commerce-api/guide/authorization-for-admin-apis.html)\n\n## Data Model\n\n### Subscriptions\nSubscriptions represent a customer's consent to receive specific types of marketing communications. Each subscription includes:\n\n- Identifier: \n  - `subscriptionId`: Descriptive identifier following kebab-case format (1-255 characters, pattern: `^[a-z0-9]+(?:-[a-z0-9]+)*$`)\n  - `siteId`: Commerce Cloud site identifier for multi-site organizations\n- Display Information: Rich text content with localization and HTML markup support\n  - `title`: Localized subscription titles with markup support (required for creation)\n  - `subtitle`: Optional localized subscription subtitles with markup support\n- Consent Configuration:\n  - `channels`: Array of supported communication methods (required, 1-10 items)\n  - `tags`: Configurable filter tags for subscription categorization (0-10 items, defaults to empty array)\n  - `consentType`: Type classification (`marketing` or `legal`, defaults to `marketing`)\n  - `consentRequired`: Whether the subscription is mandatory (defaults to `false`)\n  - `defaultStatus`: Default consent state (`opt_in` or `opt_out`, defaults to `opt_out`)\n  - `enabled`: Whether the subscription is currently active (defaults to `true`) - defined as reusable `Enabled` schema component\n- System Integration: \n  - `umaSubscriptionId`: Salesforce UMA CommSubscription object ID (15-18 characters)\n\n### Channels\nChannels define the communication methods available for a subscription:\n- `email`: Email communications\n- `sms`: SMS/text messages\n- `whatsapp`: WhatsApp\n\n### Tags\nTags can be used to filter the subscriptions for various uses. Provided tags include:\n- `homepage_banner`: Main website homepage\n- `registration`: Customer registration process\n- `checkout`: During the checkout process\n- `user_profile`: User profile management area\n\n## Response Details\n\n### Timeouts\n\nAdmin API requests must respond within 60 seconds. If a response exceeds this threshold, an HTTP 504 status code is returned. For details, see [Timeouts and Limits.](https://developer.salesforce.com/docs/commerce/commerce-api/guide/timeouts-limits.html)\n\n### Error Handling\n\nError responses follow the [RFC 7807](https://datatracker.ietf.org/doc/html/rfc7807) problem detail format. To trace errors, include a `correlation-id` header in your request — the response returns it as `x-correlation-id`. For details, see [HTTP Status Codes and Errors.](https://developer.salesforce.com/docs/commerce/commerce-api/guide/error-response-codes.html)",
+    "version": "1.1.5",
     "x-api-type": "Admin",
     "x-api-family": "Shopper"
   },
@@ -11,6 +12,7 @@
       "url": "https://{shortCode}.api.commercecloud.salesforce.com/shopper/consents/v1",
       "variables": {
         "shortCode": {
+          "description": "An eight-character string assigned to a realm for routing purposes. See [Base URL and Request Formation.](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html)",
           "default": "shortCode"
         }
       }
@@ -19,26 +21,36 @@
   "paths": {
     "/organizations/{organizationId}/subscriptions": {
       "get": {
+        "summary": "Get all subscriptions",
+        "description": "Retrieve all current subscriptions for the specified organization and site.",
         "operationId": "getSubscriptions",
         "parameters": [
           {
             "name": "organizationId",
             "in": "path",
+            "description": "An identifier for the Salesforce Commerce Cloud organization the request is being made by. It consists of a prefix 'f_ecom_' followed by a 4-character [realm identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#realm-id) and a 3-character [instance type identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#instance-id).",
             "required": true,
             "style": "simple",
             "explode": false,
             "schema": {
               "$ref": "#/components/schemas/OrganizationId"
-            }
+            },
+            "example": "f_ecom_zzxy_prd"
           },
           {
             "name": "siteId",
             "in": "query",
+            "description": "The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites.",
             "required": true,
             "style": "form",
             "explode": true,
             "schema": {
               "$ref": "#/components/schemas/SiteId"
+            },
+            "examples": {
+              "SiteId": {
+                "value": "RefArch"
+              }
             }
           }
         ],
@@ -49,6 +61,11 @@
               "application/json": {
                 "schema": {
                   "$ref": "#/components/schemas/SubscriptionsResponse"
+                },
+                "examples": {
+                  "GetSubscriptionsResponse": {
+                    "$ref": "#/components/examples/GetSubscriptionsResponse"
+                  }
                 }
               }
             }
@@ -59,6 +76,11 @@
               "application/problem+json": {
                 "schema": {
                   "$ref": "#/components/schemas/ErrorResponse"
+                },
+                "examples": {
+                  "ConsentsFeatureNotEnabled": {
+                    "$ref": "#/components/examples/ConsentsFeatureNotEnabled"
+                  }
                 }
               }
             }
@@ -75,31 +97,42 @@
     },
     "/organizations/{organizationId}/subscriptions/{subscriptionId}": {
       "put": {
+        "summary": "Create subscription",
+        "description": "Create a new subscription for the specified organization.",
         "operationId": "createSubscription",
         "parameters": [
           {
             "name": "organizationId",
             "in": "path",
+            "description": "An identifier for the Salesforce Commerce Cloud organization the request is being made by. It consists of a prefix 'f_ecom_' followed by a 4-character [realm identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#realm-id) and a 3-character [instance type identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#instance-id).",
             "required": true,
             "style": "simple",
             "explode": false,
             "schema": {
               "$ref": "#/components/schemas/OrganizationId"
-            }
+            },
+            "example": "f_ecom_zzxy_prd"
           },
           {
             "name": "siteId",
             "in": "query",
+            "description": "The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites.",
             "required": true,
             "style": "form",
             "explode": true,
             "schema": {
               "$ref": "#/components/schemas/SiteId"
+            },
+            "examples": {
+              "SiteId": {
+                "value": "RefArch"
+              }
             }
           },
           {
             "name": "subscriptionId",
             "in": "path",
+            "description": "The unique identifier of the subscription",
             "required": true,
             "style": "simple",
             "explode": false,
@@ -113,6 +146,11 @@
             "application/json": {
               "schema": {
                 "$ref": "#/components/schemas/SubscriptionPutRequest"
+              },
+              "examples": {
+                "PutSubscriptionRequest": {
+                  "$ref": "#/components/examples/PutSubscriptionRequest"
+                }
               }
             }
           },
@@ -125,6 +163,11 @@
               "application/json": {
                 "schema": {
                   "$ref": "#/components/schemas/Subscription"
+                },
+                "examples": {
+                  "PutSubscriptionResponse": {
+                    "$ref": "#/components/examples/PutSubscriptionResponse"
+                  }
                 }
               }
             }
@@ -135,6 +178,20 @@
               "application/problem+json": {
                 "schema": {
                   "$ref": "#/components/schemas/ErrorResponse"
+                },
+                "examples": {
+                  "ConsentsFeatureNotEnabled": {
+                    "$ref": "#/components/examples/ConsentsFeatureNotEnabled"
+                  },
+                  "SubscriptionCreationValidationError": {
+                    "$ref": "#/components/examples/SubscriptionCreationValidationError"
+                  },
+                  "SubscriptionIdMismatchError": {
+                    "$ref": "#/components/examples/SubscriptionIdMismatchError"
+                  },
+                  "SiteIdMismatchError": {
+                    "$ref": "#/components/examples/SiteIdMismatchError"
+                  }
                 }
               }
             }
@@ -145,6 +202,11 @@
               "application/problem+json": {
                 "schema": {
                   "$ref": "#/components/schemas/ErrorResponse"
+                },
+                "examples": {
+                  "SubscriptionAlreadyExists": {
+                    "$ref": "#/components/examples/SubscriptionAlreadyExists"
+                  }
                 }
               }
             }
@@ -159,31 +221,42 @@
         ]
       },
       "delete": {
+        "summary": "Delete subscription",
+        "description": "Delete an existing subscription for the specified organization.",
         "operationId": "deleteSubscription",
         "parameters": [
           {
             "name": "organizationId",
             "in": "path",
+            "description": "An identifier for the Salesforce Commerce Cloud organization the request is being made by. It consists of a prefix 'f_ecom_' followed by a 4-character [realm identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#realm-id) and a 3-character [instance type identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#instance-id).",
             "required": true,
             "style": "simple",
             "explode": false,
             "schema": {
               "$ref": "#/components/schemas/OrganizationId"
-            }
+            },
+            "example": "f_ecom_zzxy_prd"
           },
           {
             "name": "siteId",
             "in": "query",
+            "description": "The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites.",
             "required": true,
             "style": "form",
             "explode": true,
             "schema": {
               "$ref": "#/components/schemas/SiteId"
+            },
+            "examples": {
+              "SiteId": {
+                "value": "RefArch"
+              }
             }
           },
           {
             "name": "subscriptionId",
             "in": "path",
+            "description": "The unique identifier of the subscription",
             "required": true,
             "style": "simple",
             "explode": false,
@@ -202,6 +275,11 @@
               "application/problem+json": {
                 "schema": {
                   "$ref": "#/components/schemas/ErrorResponse"
+                },
+                "examples": {
+                  "ConsentsFeatureNotEnabled": {
+                    "$ref": "#/components/examples/ConsentsFeatureNotEnabled"
+                  }
                 }
               }
             }
@@ -216,31 +294,42 @@
         ]
       },
       "patch": {
+        "summary": "Update subscription",
+        "description": "Update an existing subscription for the specified organization.",
         "operationId": "updateSubscription",
         "parameters": [
           {
             "name": "organizationId",
             "in": "path",
+            "description": "An identifier for the Salesforce Commerce Cloud organization the request is being made by. It consists of a prefix 'f_ecom_' followed by a 4-character [realm identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#realm-id) and a 3-character [instance type identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#instance-id).",
             "required": true,
             "style": "simple",
             "explode": false,
             "schema": {
               "$ref": "#/components/schemas/OrganizationId"
-            }
+            },
+            "example": "f_ecom_zzxy_prd"
           },
           {
             "name": "siteId",
             "in": "query",
+            "description": "The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites.",
             "required": true,
             "style": "form",
             "explode": true,
             "schema": {
               "$ref": "#/components/schemas/SiteId"
+            },
+            "examples": {
+              "SiteId": {
+                "value": "RefArch"
+              }
             }
           },
           {
             "name": "subscriptionId",
             "in": "path",
+            "description": "The unique identifier of the subscription",
             "required": true,
             "style": "simple",
             "explode": false,
@@ -254,6 +343,11 @@
             "application/json": {
               "schema": {
                 "$ref": "#/components/schemas/SubscriptionPatchRequest"
+              },
+              "examples": {
+                "PatchSubscriptionRequest": {
+                  "$ref": "#/components/examples/PatchSubscriptionRequest"
+                }
               }
             }
           },
@@ -266,6 +360,11 @@
               "application/json": {
                 "schema": {
                   "$ref": "#/components/schemas/Subscription"
+                },
+                "examples": {
+                  "PatchSubscriptionResponse": {
+                    "$ref": "#/components/examples/PatchSubscriptionResponse"
+                  }
                 }
               }
             }
@@ -276,6 +375,20 @@
               "application/problem+json": {
                 "schema": {
                   "$ref": "#/components/schemas/ErrorResponse"
+                },
+                "examples": {
+                  "ConsentsFeatureNotEnabled": {
+                    "$ref": "#/components/examples/ConsentsFeatureNotEnabled"
+                  },
+                  "SubscriptionUpdateValidationError": {
+                    "$ref": "#/components/examples/SubscriptionUpdateValidationError"
+                  },
+                  "SubscriptionIdMismatchError": {
+                    "$ref": "#/components/examples/SubscriptionIdMismatchError"
+                  },
+                  "SiteIdMismatchError": {
+                    "$ref": "#/components/examples/SiteIdMismatchError"
+                  }
                 }
               }
             }
@@ -295,16 +408,21 @@
     "schemas": {
       "OrganizationId": {
         "type": "string",
-        "maxLength": 32,
-        "minLength": 1
+        "description": "An identifier for the Salesforce Commerce Cloud organization the request is being made by. It consists of a prefix 'f_ecom_' followed by a 4-character [realm identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#realm-id) and a 3-character [instance type identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#instance-id).",
+        "example": "f_ecom_zzxy_prd",
+        "pattern": "^f_ecom_[a-z]{4}_(prd|stg|dev|s[0-9]{2}|[0-9]{3})$"
       },
       "SiteId": {
         "type": "string",
+        "description": "The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites",
+        "example": "RefArch",
         "maxLength": 32,
         "minLength": 1
       },
       "SubscriptionId": {
         "type": "string",
+        "description": "Identifier for the subscription",
+        "example": "weekly-newsletter",
         "maxLength": 255,
         "minLength": 1,
         "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
@@ -312,13 +430,22 @@
       "MarkupText": {
         "type": "object",
         "additionalProperties": false,
+        "description": "The markup text for rich text content",
+        "example": {
+          "markup": "Monthly <strong>Product Updates</strong> - <a href=\"https://example.com\">Learn More</a>",
+          "source": "Monthly <strong>Product Updates</strong> - <a href=\"https://example.com\">Learn More</a>"
+        },
         "properties": {
           "markup": {
             "type": "string",
+            "description": "The rendered HTML",
+            "example": "Monthly <strong>Product Updates</strong> - <a href=\"https://example.com\">Learn More</a>",
             "maxLength": 2000
           },
           "source": {
             "type": "string",
+            "description": "The raw markup text",
+            "example": "Monthly <strong>Product Updates</strong> - <a href=\"https://example.com\">Learn More</a>",
             "maxLength": 2000
           }
         },
@@ -331,16 +458,40 @@
         "type": "object",
         "additionalProperties": {
           "$ref": "#/components/schemas/MarkupText"
+        },
+        "description": "The localized title of the subscription with markup support",
+        "example": {
+          "default": {
+            "markup": "Monthly <strong>Product Updates</strong>",
+            "source": "Monthly <strong>Product Updates</strong>"
+          },
+          "fr-FR": {
+            "markup": "Mises à jour <strong>Produit Mensuelles</strong>",
+            "source": "Mises à jour <strong>Produit Mensuelles</strong>"
+          }
         }
       },
       "SubscriptionSubtitle": {
         "type": "object",
         "additionalProperties": {
           "$ref": "#/components/schemas/MarkupText"
+        },
+        "description": "The localized subtitle of the subscription with markup support",
+        "example": {
+          "default": {
+            "markup": "Stay informed about new features - <a href=\"https://example.com\">Learn More</a>",
+            "source": "Stay informed about new features - <a href=\"https://example.com\">Learn More</a>"
+          },
+          "fr-FR": {
+            "markup": "Restez informé des nouvelles fonctionnalités - <a href=\"https://example.com\">En savoir plus</a>",
+            "source": "Restez informé des nouvelles fonctionnalités - <a href=\"https://example.com\">En savoir plus</a>"
+          }
         }
       },
       "Tag": {
         "type": "string",
+        "description": "Filter criteria for consent subscriptions",
+        "example": "homepage_banner",
         "maxLength": 256,
         "minLength": 1
       },
@@ -350,23 +501,30 @@
           "email",
           "sms",
           "whatsapp"
-        ]
+        ],
+        "example": "email"
       },
       "ConsentType": {
         "type": "string",
         "default": "marketing",
+        "description": "Type of consent subscription",
         "enum": [
           "marketing",
           "legal"
-        ]
+        ],
+        "example": "marketing"
       },
       "ConsentRequired": {
         "type": "boolean",
-        "default": false
+        "default": false,
+        "description": "Whether this subscription is mandatory",
+        "example": false
       },
       "Enabled": {
         "type": "boolean",
-        "default": true
+        "default": true,
+        "description": "Whether this subscription is currently enabled",
+        "example": true
       },
       "Subscription": {
         "type": "object",
@@ -386,6 +544,12 @@
           "tags": {
             "type": "array",
             "default": [],
+            "example": [
+              "homepage_banner",
+              "user_profile",
+              "checkout",
+              "registration"
+            ],
             "items": {
               "$ref": "#/components/schemas/Tag"
             },
@@ -394,6 +558,10 @@
           },
           "channels": {
             "type": "array",
+            "example": [
+              "email",
+              "sms"
+            ],
             "items": {
               "$ref": "#/components/schemas/Channel"
             },
@@ -402,6 +570,8 @@
           },
           "umaSubscriptionId": {
             "type": "string",
+            "description": "Salesforce Id for the corresponding CommSubscription object in UMA",
+            "example": "0Xl000000000000000",
             "maxLength": 18,
             "minLength": 15
           },
@@ -414,10 +584,12 @@
           "defaultStatus": {
             "type": "string",
             "default": "opt_out",
+            "description": "Default state of the consent value",
             "enum": [
               "opt_in",
               "opt_out"
-            ]
+            ],
+            "example": "opt_out"
           },
           "enabled": {
             "$ref": "#/components/schemas/Enabled"
@@ -434,6 +606,44 @@
         "properties": {
           "data": {
             "type": "array",
+            "example": [
+              {
+                "id": "weekly-newsletter",
+                "siteId": "RefArch",
+                "title": {
+                  "default": {
+                    "markup": "Weekly <strong>Newsletter</strong>",
+                    "source": "Weekly <strong>Newsletter</strong>"
+                  },
+                  "fr-FR": {
+                    "markup": "Bulletin <strong>Hebdomadaire</strong>",
+                    "source": "Bulletin <strong>Hebdomadaire</strong>"
+                  }
+                },
+                "subtitle": {
+                  "default": {
+                    "markup": "Get our weekly newsletter with the latest updates - <a href=\"https://example.com\">Subscribe</a>",
+                    "source": "Get our weekly newsletter with the latest updates - <a href=\"https://example.com\">Subscribe</a>"
+                  },
+                  "fr-FR": {
+                    "markup": "Recevez notre bulletin hebdomadaire avec les dernières mises à jour - <a href=\"https://example.com\">S&rsquo;abonner</a>",
+                    "source": "Recevez notre bulletin hebdomadaire avec les dernières mises à jour - <a href=\"https://example.com\">S&rsquo;abonner</a>"
+                  }
+                },
+                "tags": [
+                  "homepage_banner",
+                  "user_profile"
+                ],
+                "channels": [
+                  "email"
+                ],
+                "umaSubscriptionId": "0Xl000000000000000",
+                "consentType": "marketing",
+                "consentRequired": false,
+                "defaultStatus": "OPT_OUT",
+                "enabled": true
+              }
+            ],
             "items": {
               "$ref": "#/components/schemas/Subscription"
             },
@@ -451,17 +661,25 @@
         "properties": {
           "title": {
             "type": "string",
+            "description": "A short, human-readable summary of the problem\ntype.  It will not change from occurrence to occurrence of the \nproblem, except for purposes of localization\n",
+            "example": "You do not have enough credit",
             "maxLength": 256
           },
           "type": {
             "type": "string",
+            "description": "A URI reference [RFC3986] that identifies the\nproblem type.  This specification encourages that, when\ndereferenced, it provide human-readable documentation for the\nproblem type (e.g., using HTML [W3C.REC-html5-20141028]).  When\nthis member is not present, its value is assumed to be\n\"about:blank\". It accepts relative URIs; this means\nthat they must be resolved relative to the document's base URI, as\nper [RFC3986], Section 5.\n",
+            "example": "NotEnoughMoney",
             "maxLength": 2048
           },
           "detail": {
-            "type": "string"
+            "type": "string",
+            "description": "A human-readable explanation specific to this occurrence of the problem.",
+            "example": "Your current balance is 30, but that costs 50"
           },
           "instance": {
             "type": "string",
+            "description": "A URI reference that identifies the specific\noccurrence of the problem.  It may or may not yield further\ninformation if dereferenced.  It accepts relative URIs; this means\nthat they must be resolved relative to the document's base URI, as\nper [RFC3986], Section 5.\n",
+            "example": "/account/12345/msgs/abc",
             "maxLength": 2048
           }
         },
@@ -510,10 +728,12 @@
           "defaultStatus": {
             "type": "string",
             "default": "opt_out",
+            "description": "Default state of the consent value",
             "enum": [
               "opt_in",
               "opt_out"
-            ]
+            ],
+            "example": "opt_out"
           },
           "enabled": {
             "$ref": "#/components/schemas/Enabled"
@@ -563,10 +783,12 @@
           "defaultStatus": {
             "type": "string",
             "default": "opt_out",
+            "description": "Default state of the consent value",
             "enum": [
               "opt_in",
               "opt_out"
-            ]
+            ],
+            "example": "opt_out"
           },
           "enabled": {
             "$ref": "#/components/schemas/Enabled"
@@ -578,27 +800,318 @@
       "organizationId": {
         "name": "organizationId",
         "in": "path",
+        "description": "An identifier for the Salesforce Commerce Cloud organization the request is being made by. It consists of a prefix 'f_ecom_' followed by a 4-character [realm identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#realm-id) and a 3-character [instance type identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#instance-id).",
         "required": true,
         "style": "simple",
         "explode": false,
         "schema": {
           "$ref": "#/components/schemas/OrganizationId"
-        }
+        },
+        "example": "f_ecom_zzxy_prd"
       },
       "siteId": {
         "name": "siteId",
         "in": "query",
+        "description": "The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites.",
         "required": true,
         "style": "form",
         "explode": true,
         "schema": {
           "$ref": "#/components/schemas/SiteId"
+        },
+        "examples": {
+          "SiteId": {
+            "value": "RefArch"
+          }
+        }
+      }
+    },
+    "examples": {
+      "GetSubscriptionsResponse": {
+        "summary": "Example response for getting all subscriptions for a specific site (RefArch)",
+        "value": {
+          "data": [
+            {
+              "subscriptionId": "weekly-newsletter",
+              "siteId": "RefArch",
+              "title": {
+                "default": {
+                  "markup": "Weekly <strong>Newsletter</strong>",
+                  "source": "Weekly <strong>Newsletter</strong>"
+                },
+                "fr-FR": {
+                  "markup": "Bulletin <strong>Hebdomadaire</strong>",
+                  "source": "Bulletin <strong>Hebdomadaire</strong>"
+                }
+              },
+              "subtitle": {
+                "default": {
+                  "markup": "Get our weekly newsletter with the latest updates - <a href=\"https://example.com\">Subscribe</a>",
+                  "source": "Get our weekly newsletter with the latest updates - <a href=\"https://example.com\">Subscribe</a>"
+                },
+                "fr-FR": {
+                  "markup": "Recevez notre bulletin hebdomadaire avec les dernières mises à jour - <a href=\"https://example.com\">S&rsquo;abonner</a>",
+                  "source": "Recevez notre bulletin hebdomadaire avec les dernières mises à jour - <a href=\"https://example.com\">S&rsquo;abonner</a>"
+                }
+              },
+              "tags": [
+                "homepage_banner",
+                "user_profile"
+              ],
+              "channels": [
+                "email",
+                "whatsapp"
+              ],
+              "umaSubscriptionId": "0Xl000000000000000",
+              "consentType": "marketing",
+              "consentRequired": false,
+              "defaultStatus": "opt_out",
+              "enabled": true
+            },
+            {
+              "subscriptionId": "promotional-offers",
+              "siteId": "RefArch",
+              "title": {
+                "default": {
+                  "markup": "Promotional <em>Offers</em>",
+                  "source": "Promotional <em>Offers</em>"
+                },
+                "fr-FR": {
+                  "markup": "Offres <em>Promotionnelles</em>",
+                  "source": "Offres <em>Promotionnelles</em>"
+                }
+              },
+              "subtitle": {
+                "default": {
+                  "markup": "Receive special promotional offers - <a href=\"https://example.com/offers\">View Offers</a>",
+                  "source": "Receive special promotional offers - <a href=\"https://example.com/offers\">View Offers</a>"
+                },
+                "fr-FR": {
+                  "markup": "Recevez des offres promotionnelles spéciales - <a href=\"https://example.com/offers\">Voir les offres</a>",
+                  "source": "Recevez des offres promotionnelles spéciales - <a href=\"https://example.com/offers\">Voir les offres</a>"
+                }
+              },
+              "tags": [
+                "checkout"
+              ],
+              "channels": [
+                "sms",
+                "email"
+              ],
+              "umaSubscriptionId": "0Xl000000000000001",
+              "consentType": "legal",
+              "consentRequired": true,
+              "defaultStatus": "opt_in",
+              "enabled": true
+            }
+          ]
+        }
+      },
+      "ConsentsFeatureNotEnabled": {
+        "value": {
+          "title": "Consents Feature Not Enabled",
+          "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/consents-feature-not-enabled",
+          "detail": "The Marketing Consents feature is not enabled for this organization."
+        }
+      },
+      "PutSubscriptionRequest": {
+        "summary": "Example request for creating or replacing a subscription",
+        "value": {
+          "subscriptionId": "weekly-newsletter",
+          "siteId": "RefArch",
+          "title": {
+            "default": {
+              "markup": "Weekly <strong>Newsletter</strong>",
+              "source": "Weekly <strong>Newsletter</strong>"
+            },
+            "fr-FR": {
+              "markup": "Bulletin <strong>Hebdomadaire</strong>",
+              "source": "Bulletin <strong>Hebdomadaire</strong>"
+            }
+          },
+          "subtitle": {
+            "default": {
+              "markup": "Get our weekly newsletter with the latest updates - <a href=\"https://example.com\">Subscribe</a>",
+              "source": "Get our weekly newsletter with the latest updates - <a href=\"https://example.com\">Subscribe</a>"
+            },
+            "fr-FR": {
+              "markup": "Recevez notre bulletin hebdomadaire avec les dernières mises à jour - <a href=\"https://example.com\">S&rsquo;abonner</a>",
+              "source": "Recevez notre bulletin hebdomadaire avec les dernières mises à jour - <a href=\"https://example.com\">S&rsquo;abonner</a>"
+            }
+          },
+          "tags": [
+            "homepage_banner",
+            "user_profile"
+          ],
+          "channels": [
+            "email",
+            "whatsapp"
+          ]
+        }
+      },
+      "PutSubscriptionResponse": {
+        "summary": "Example response for creating or replacing a subscription",
+        "value": {
+          "subscriptionId": "weekly-newsletter",
+          "siteId": "RefArch",
+          "title": {
+            "default": {
+              "markup": "Weekly <strong>Newsletter</strong>",
+              "source": "Weekly <strong>Newsletter</strong>"
+            },
+            "fr-FR": {
+              "markup": "Bulletin <strong>Hebdomadaire</strong>",
+              "source": "Bulletin <strong>Hebdomadaire</strong>"
+            }
+          },
+          "subtitle": {
+            "default": {
+              "markup": "Get our weekly newsletter with the latest updates - <a href=\"https://example.com\">Subscribe</a>",
+              "source": "Get our weekly newsletter with the latest updates - <a href=\"https://example.com\">Subscribe</a>"
+            },
+            "fr-FR": {
+              "markup": "Recevez notre bulletin hebdomadaire avec les dernières mises à jour - <a href=\"https://example.com\">S&rsquo;abonner</a>",
+              "source": "Recevez notre bulletin hebdomadaire avec les dernières mises à jour - <a href=\"https://example.com\">S&rsquo;abonner</a>"
+            }
+          },
+          "tags": [
+            "homepage_banner",
+            "user_profile"
+          ],
+          "channels": [
+            "email",
+            "whatsapp"
+          ],
+          "umaSubscriptionId": "0Xl000000000000000",
+          "consentType": "marketing",
+          "consentRequired": false,
+          "defaultStatus": "opt_out",
+          "enabled": true
+        }
+      },
+      "SubscriptionCreationValidationError": {
+        "value": {
+          "title": "Subscription Creation Validation Error",
+          "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/subscription-creation-validation-error",
+          "detail": "Unable to create consent subscription."
+        }
+      },
+      "SubscriptionIdMismatchError": {
+        "value": {
+          "title": "Subscription ID Mismatch",
+          "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/subscription-id-mismatch",
+          "detail": "The subscriptionId in the request body does not match the subscriptionId parameter."
+        }
+      },
+      "SiteIdMismatchError": {
+        "value": {
+          "title": "Site ID Mismatch",
+          "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/site-id-mismatch",
+          "detail": "The siteId in the request body does not match the siteId parameter. Both must specify the same site."
+        }
+      },
+      "SubscriptionAlreadyExists": {
+        "value": {
+          "title": "Subscription Already Exists",
+          "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/subscription-already-exists",
+          "detail": "A subscription with this ID already exists. Use PATCH to update existing subscriptions."
+        }
+      },
+      "PatchSubscriptionRequest": {
+        "summary": "Example request for updating a subscription",
+        "value": {
+          "subscriptionId": "weekly-newsletter",
+          "siteId": "RefArch",
+          "title": {
+            "default": {
+              "markup": "Weekly <strong>Newsletter</strong> - <em>Updated</em>",
+              "source": "Weekly <strong>Newsletter</strong> - <em>Updated</em>"
+            },
+            "fr-FR": {
+              "markup": "Bulletin <strong>Hebdomadaire</strong> - <em>Mis à jour</em>",
+              "source": "Bulletin <strong>Hebdomadaire</strong> - <em>Mis à jour</em>"
+            }
+          },
+          "subtitle": {
+            "default": {
+              "markup": "Get our updated weekly newsletter with the latest features - <a href=\"https://example.com\">Learn More</a>",
+              "source": "Get our updated weekly newsletter with the latest features - <a href=\"https://example.com\">Learn More</a>"
+            },
+            "fr-FR": {
+              "markup": "Recevez notre bulletin hebdomadaire mis à jour avec les dernières fonctionnalités - <a href=\"https://example.com\">En savoir plus</a>",
+              "source": "Recevez notre bulletin hebdomadaire mis à jour avec les dernières fonctionnalités - <a href=\"https://example.com\">En savoir plus</a>"
+            }
+          },
+          "tags": [
+            "homepage_banner",
+            "user_profile",
+            "checkout_page"
+          ],
+          "channels": [
+            "email",
+            "sms",
+            "whatsapp"
+          ],
+          "consentType": "marketing",
+          "consentRequired": false,
+          "defaultStatus": "opt_out",
+          "enabled": true
+        }
+      },
+      "PatchSubscriptionResponse": {
+        "summary": "Example response for updating a subscription",
+        "value": {
+          "subscriptionId": "weekly-newsletter",
+          "siteId": "RefArch",
+          "title": {
+            "default": {
+              "markup": "Weekly <strong>Newsletter</strong> - <em>Updated</em>",
+              "source": "Weekly <strong>Newsletter</strong> - <em>Updated</em>"
+            },
+            "fr-FR": {
+              "markup": "Bulletin <strong>Hebdomadaire</strong> - <em>Mis à jour</em>",
+              "source": "Bulletin <strong>Hebdomadaire</strong> - <em>Mis à jour</em>"
+            }
+          },
+          "subtitle": {
+            "default": {
+              "markup": "Get our updated weekly newsletter with the latest features - <a href=\"https://example.com\">Learn More</a>",
+              "source": "Get our updated weekly newsletter with the latest features - <a href=\"https://example.com\">Learn More</a>"
+            },
+            "fr-FR": {
+              "markup": "Recevez notre bulletin hebdomadaire mis à jour avec les dernières fonctionnalités - <a href=\"https://example.com\">En savoir plus</a>",
+              "source": "Recevez notre bulletin hebdomadaire mis à jour avec les dernières fonctionnalités - <a href=\"https://example.com\">En savoir plus</a>"
+            }
+          },
+          "tags": [
+            "homepage_banner",
+            "user_profile",
+            "checkout_page"
+          ],
+          "channels": [
+            "email",
+            "sms",
+            "whatsapp"
+          ],
+          "umaSubscriptionId": "0Xl000000000000000",
+          "consentType": "marketing",
+          "consentRequired": false,
+          "defaultStatus": "opt_out",
+          "enabled": true
+        }
+      },
+      "SubscriptionUpdateValidationError": {
+        "value": {
+          "title": "Subscription Update Validation Error",
+          "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/subscription-update-validation-error",
+          "detail": "Unable to update consent subscription due to validation errors."
         }
       }
     },
     "securitySchemes": {
       "AmOAuth2": {
         "type": "oauth2",
+        "description": "AccountManager OAuth 2.0 bearer token Authentication.",
         "flows": {
           "clientCredentials": {
             "tokenUrl": "https://account.demandware.com/dwsso/oauth2/access_token",
@@ -610,10 +1123,8 @@
           "authorizationCode": {
             "authorizationUrl": "https://account.demandware.com/dwsso/oauth2/authorize",
             "tokenUrl": "https://account.demandware.com/dwsso/oauth2/access_token",
-            "scopes": {
-              "sfcc.consents": "Consents READONLY",
-              "sfcc.consents.rw": "Consents"
-            }
+            "refreshUrl": "https://account.demandware.com/dwsso/oauth2/access_token",
+            "scopes": {}
           }
         }
       }