@salesforce/b2c-tooling-sdk 2.3.0 → 2.5.0

package/node_modules/@salesforce/b2c-api-schemas/scapi/site/seo/v1.json

@@ -2,7 +2,8 @@
   "openapi": "3.0.3",
   "info": {
     "title": "Seo",
-    "version": "1.0.11",
+    "description": "[Download API specification](https://developer.salesforce.com/static/commercecloud/commerce-api/seo/seo-oas-v1-public.yaml)\n\n# API Overview\n\nThis API uploads a custom sitemap and triggers the sitemap generation process. \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 the relevant scope(s) 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) guide.\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## Related APIs\n\n- [Shopper SEO](https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-seo?meta=Summary) — Resolve SEO-friendly URLs for shoppers.",
+    "version": "1.0.12",
     "x-api-type": "Admin",
     "x-api-family": "Site"
   },
@@ -11,6 +12,7 @@
       "url": "https://{shortCode}.api.commercecloud.salesforce.com/site/seo/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}/sitemap": {
       "put": {
+        "summary": "Upload a custom sitemap and trigger sitemap generation process.",
+        "description": "This API uploads a custom sitemap and triggers the sitemap generation process.",
         "operationId": "uploadCustomSitemapAndTriggerSitemapGeneration",
         "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"
+              }
             }
           }
         ],
@@ -47,6 +59,11 @@
             "multipart/form-data": {
               "schema": {
                 "$ref": "#/components/schemas/SitemapRequest"
+              },
+              "examples": {
+                "sitemapRequestBody": {
+                  "$ref": "#/components/examples/sitemapRequestBody"
+                }
               }
             }
           },
@@ -57,6 +74,7 @@
             "description": "The site generation process runs asynchronously and takes a few minutes to complete. The generated sitemap is available at the location specified in the location header.",
             "headers": {
               "Location": {
+                "description": "The generated sitemap location url",
                 "style": "simple",
                 "explode": false,
                 "schema": {
@@ -71,6 +89,11 @@
               "application/problem+json": {
                 "schema": {
                   "$ref": "#/components/schemas/ErrorResponse"
+                },
+                "examples": {
+                  "putSitemap400": {
+                    "$ref": "#/components/examples/putSitemap400"
+                  }
                 }
               }
             }
@@ -81,6 +104,11 @@
               "application/problem+json": {
                 "schema": {
                   "$ref": "#/components/schemas/ErrorResponse"
+                },
+                "examples": {
+                  "putSitemap404": {
+                    "$ref": "#/components/examples/putSitemap404"
+                  }
                 }
               }
             }
@@ -91,6 +119,11 @@
               "application/problem+json": {
                 "schema": {
                   "$ref": "#/components/schemas/ErrorResponse"
+                },
+                "examples": {
+                  "putSitemap409": {
+                    "$ref": "#/components/examples/putSitemap409"
+                  }
                 }
               }
             }
@@ -110,34 +143,31 @@
     "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
       },
-      "String4000": {
-        "type": "string",
-        "maxLength": 4000
-      },
       "SitemapRequest": {
         "type": "object",
         "properties": {
           "customSitemapFile": {
-            "allOf": [
-              {
-                "$ref": "#/components/schemas/String4000"
-              }
-            ]
+            "type": "string",
+            "description": "The custom sitemap file to be uploaded. Must conform to the [Sitemap Protocol](https://www.sitemaps.org/protocol.html), with a root `<urlset>` element and well-formed `<url>` entries.The filename must not start with `sitemap` nor contain forward or backward slashes. The file must contain valid xml content and the filename must have an .xml extension.",
+            "example": "custom-sitemap.xml",
+            "maxLength": 4000
           },
           "hostname": {
-            "allOf": [
-              {
-                "$ref": "#/components/schemas/String4000"
-              }
-            ],
+            "type": "string",
+            "description": "The hostname for which the sitemap will be generated. The hostname must be listed in the aliases file in Business Manager",
+            "example": "www.abc.com",
+            "maxLength": 4000,
             "minLength": 1
           }
         },
@@ -148,6 +178,8 @@
       },
       "Location": {
         "type": "string",
+        "description": "URL where the resource is located.",
+        "example": "/index.html",
         "maxLength": 2048
       },
       "ErrorResponse": {
@@ -156,17 +188,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
           }
         },
@@ -181,27 +221,66 @@
       "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": {
+      "sitemapRequestBody": {
+        "value": {
+          "customSitemapFile": "sitemap.xml",
+          "hostname": "secure.sitegenesis.com"
+        }
+      },
+      "putSitemap400": {
+        "value": {
+          "title": "Bad Request",
+          "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/validation",
+          "detail": "The custom sitemap must be an XML file."
+        }
+      },
+      "putSitemap404": {
+        "value": {
+          "title": "The given hostname was not found in the alias file.",
+          "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors",
+          "detail": "The hostname was not found in the alias file.",
+          "hostname": "www.abc.com"
+        }
+      },
+      "putSitemap409": {
+        "value": {
+          "title": "Sitemap Generation In Progress",
+          "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/validation",
+          "detail": "The previous generate sitemap request has not completed."
         }
       }
     },
     "securitySchemes": {
       "AmOAuth2": {
         "type": "oauth2",
+        "description": "AccountManager OAuth 2.0 bearer token Authentication.",
         "flows": {
           "clientCredentials": {
             "tokenUrl": "https://account.demandware.com/dwsso/oauth2/access_token",
@@ -212,9 +291,8 @@
           "authorizationCode": {
             "authorizationUrl": "https://account.demandware.com/dwsso/oauth2/authorize",
             "tokenUrl": "https://account.demandware.com/dwsso/oauth2/access_token",
-            "scopes": {
-              "sfcc.seo.rw": "Allows write operations on seo."
-            }
+            "refreshUrl": "https://account.demandware.com/dwsso/oauth2/access_token",
+            "scopes": {}
           }
         }
       }