@salesforce/b2c-tooling-sdk 2.4.0 → 2.5.0

package/node_modules/@salesforce/b2c-api-schemas/scapi/configuration/cors/v1.json

@@ -2,7 +2,8 @@
   "openapi": "3.0.3",
   "info": {
     "title": "Cors",
-    "version": "1.1.0",
+    "description": "[Download API specification](https://developer.salesforce.com/static/commercecloud/commerce-api/cors/cors-oas-v1-public.yaml)\n\n# API Overview\n\nThe CORS Preferences API allows you to manage your Cross-Origin Resource Sharing (CORS) preferences.\n\nBy specifying which domains are permitted to access a site, you can define exceptions to the same-site policy that browsers would otherwise enforce.\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 `sfcc.cors-preferences.rw` (read-write access) or `sfcc.cors-preferences` (read-only access) in the client ID used to generate the token. For 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.](https://developer.salesforce.com/docs/commerce/commerce-api/guide/authorization-for-admin-apis.html)\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)\n\n## Use Cases\n\n### Manage CORS configuration\n\nYou can use the preferences/cors endpoint to retrieve, set, or delete your configuration for CORS origins.\n\n## Usage Notes\n\n1. This configuration is made per client ID and site.\n2. All known domain names and aliases are added to the list automatically and do not need to be configured for CORS explicitly.\n3. If a configuration is absent, CORS will not be active. To enable cors for a client without specifying custom origins, configure the client and site with an empty origin list. The known domain names and aliases will still apply.",
+    "version": "1.1.1",
     "x-api-type": "Admin",
     "x-api-family": "Configuration"
   },
@@ -11,6 +12,7 @@
       "url": "https://{shortCode}.api.commercecloud.salesforce.com/configuration/cors/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}/cors": {
       "get": {
+        "summary": "Return all CORS preferences for the given site.",
+        "description": "Return all CORS preferences for the given site.",
         "operationId": "getCorsPreferences",
         "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,14 @@
               "application/json": {
                 "schema": {
                   "$ref": "#/components/schemas/CorsPreferences"
+                },
+                "examples": {
+                  "getCorsResultWithMappingsExample": {
+                    "$ref": "#/components/examples/getCorsResultWithMappingsExample"
+                  },
+                  "getCorsResultWithoutMappingsExample": {
+                    "$ref": "#/components/examples/getCorsResultWithoutMappingsExample"
+                  }
                 }
               }
             }
@@ -64,26 +84,36 @@
         ]
       },
       "put": {
+        "summary": "Create or replace all CORS preferences for the given site.",
+        "description": "Create or replace all CORS preferences for the given site.",
         "operationId": "updateCorsPreferences",
         "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"
+              }
             }
           }
         ],
@@ -92,6 +122,11 @@
             "application/json": {
               "schema": {
                 "$ref": "#/components/schemas/CorsPreferences"
+              },
+              "examples": {
+                "CorsPutBodyExample": {
+                  "$ref": "#/components/examples/CorsPutBodyExample"
+                }
               }
             }
           },
@@ -104,6 +139,14 @@
               "application/json": {
                 "schema": {
                   "$ref": "#/components/schemas/CorsPreferences"
+                },
+                "examples": {
+                  "updateCorsResultWithMappingsExample": {
+                    "$ref": "#/components/examples/updateCorsResultWithMappingsExample"
+                  },
+                  "updateCorsResultWithoutMappingsExample": {
+                    "$ref": "#/components/examples/updateCorsResultWithoutMappingsExample"
+                  }
                 }
               }
             }
@@ -114,6 +157,14 @@
               "application/json": {
                 "schema": {
                   "$ref": "#/components/schemas/CorsPreferences"
+                },
+                "examples": {
+                  "updateCorsResultWithMappingsExample": {
+                    "$ref": "#/components/examples/updateCorsResultWithMappingsExample"
+                  },
+                  "updateCorsResultWithoutMappingsExample": {
+                    "$ref": "#/components/examples/updateCorsResultWithoutMappingsExample"
+                  }
                 }
               }
             }
@@ -124,6 +175,14 @@
               "application/json": {
                 "schema": {
                   "$ref": "#/components/schemas/ErrorResponse"
+                },
+                "examples": {
+                  "CorsBadRequestMissingClientIdExample": {
+                    "$ref": "#/components/examples/CorsBadRequestMissingClientIdExample"
+                  },
+                  "CorsBadRequestInvalidDomainNamesExample": {
+                    "$ref": "#/components/examples/CorsBadRequestInvalidDomainNamesExample"
+                  }
                 }
               }
             }
@@ -138,26 +197,36 @@
         ]
       },
       "delete": {
+        "summary": "Delete all CORS preferences for the given site.",
+        "description": "Delete all CORS preferences for the given site.",
         "operationId": "deleteCorsPreferences",
         "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"
+              }
             }
           }
         ],
@@ -180,25 +249,33 @@
     "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
       },
       "CorsClientPreferences": {
         "type": "object",
+        "description": "Document representing all CORS preferences of a specific client",
         "properties": {
           "clientId": {
             "type": "string",
+            "description": "Client ID",
+            "example": "12345678-90ab-cdef-fedc-ba0987654321",
             "pattern": "^[-a-zA-Z0-9]+$"
           },
           "origins": {
             "type": "array",
+            "description": "List containing allowed origins in the format '<scheme>://<domain>.<tld>'",
             "items": {
               "type": "string",
+              "example": "[\"http://foo.com\",\"https://foo.bar.com\",\"myapp://example.com\"]",
               "pattern": "^[a-zA-Z_0-9][-.+a-zA-Z_0-9]+://[-.a-zA-Z_0-9]{1,253}$"
             }
           }
@@ -210,9 +287,11 @@
       },
       "CorsPreferences": {
         "type": "object",
+        "description": "Document representing all CORS preferences for a given site",
         "properties": {
           "corsClientPreferences": {
             "type": "array",
+            "description": "List of client-specific CORS preferences",
             "items": {
               "$ref": "#/components/schemas/CorsClientPreferences"
             }
@@ -225,17 +304,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
           }
         },
@@ -250,27 +337,102 @@
       "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": {
+      "getCorsResultWithMappingsExample": {
+        "value": {
+          "corsClientPreferences": [
+            {
+              "clientId": "12345678-90ab-cdef-fedc-ba0987654321",
+              "origins": [
+                "http://foo.com",
+                "https://foo.bar.com",
+                "myapp://example.com"
+              ]
+            }
+          ]
+        }
+      },
+      "getCorsResultWithoutMappingsExample": {
+        "value": {}
+      },
+      "CorsPutBodyExample": {
+        "value": {
+          "corsClientPreferences": [
+            {
+              "clientId": "12345678-90ab-cdef-fedc-ba0987654321",
+              "origins": [
+                "http://foo.com",
+                "https://foo.bar.com",
+                "myapp://example.com"
+              ]
+            }
+          ]
+        }
+      },
+      "updateCorsResultWithMappingsExample": {
+        "value": {
+          "corsClientPreferences": [
+            {
+              "clientId": "12345678-90ab-cdef-fedc-ba0987654321",
+              "origins": [
+                "http://foo.com",
+                "https://foo.bar.com",
+                "myapp://example.com"
+              ]
+            }
+          ]
+        }
+      },
+      "updateCorsResultWithoutMappingsExample": {
+        "value": {}
+      },
+      "CorsBadRequestMissingClientIdExample": {
+        "value": {
+          "title": "Bad Request",
+          "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/bad-request",
+          "detail": "Submitted content was invalid: Client ID must not be null or empty",
+          "parameter": "Submitted content was invalid: Client ID must not be null or empty"
+        }
+      },
+      "CorsBadRequestInvalidDomainNamesExample": {
+        "value": {
+          "title": "Bad Request",
+          "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/bad-request",
+          "detail": "Submitted content was invalid: Origins must contain only valid domain names in the format '<scheme>://<domain>.<tld>', without a port or path.",
+          "parameter": "Submitted content was invalid: Origins must contain only valid domain names in the format '<scheme>://<domain>.<tld>', without a port or path."
         }
       }
     },
     "securitySchemes": {
       "AmOAuth2": {
         "type": "oauth2",
+        "description": "AccountManager OAuth 2.0 bearer token Authentication.",
         "flows": {
           "clientCredentials": {
             "tokenUrl": "https://account.demandware.com/dwsso/oauth2/access_token",
@@ -282,10 +444,8 @@
           "authorizationCode": {
             "authorizationUrl": "https://account.demandware.com/dwsso/oauth2/authorize",
             "tokenUrl": "https://account.demandware.com/dwsso/oauth2/access_token",
-            "scopes": {
-              "sfcc.cors-preferences": "CORS preferences READONLY scope",
-              "sfcc.cors-preferences.rw": "CORS preferences scope"
-            }
+            "refreshUrl": "https://account.demandware.com/dwsso/oauth2/access_token",
+            "scopes": {}
           }
         }
       }