@salesforce/b2c-tooling-sdk 1.24.2 → 2.1.0

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

@@ -0,0 +1,913 @@
+{
+  "openapi": "3.0.3",
+  "info": {
+    "title": "Shopper Consents",
+    "version": "1.2.0",
+    "x-api-type": "Shopper",
+    "x-api-family": "Shopper"
+  },
+  "servers": [
+    {
+      "url": "https://{shortCode}.api.commercecloud.salesforce.com/shopper/shopper-consents/v1",
+      "variables": {
+        "shortCode": {
+          "default": "shortCode"
+        }
+      }
+    }
+  ],
+  "paths": {
+    "/organizations/{organizationId}/subscriptions": {
+      "get": {
+        "operationId": "getSubscriptions",
+        "parameters": [
+          {
+            "name": "organizationId",
+            "in": "path",
+            "required": true,
+            "style": "simple",
+            "explode": false,
+            "schema": {
+              "$ref": "#/components/schemas/OrganizationId"
+            }
+          },
+          {
+            "name": "siteId",
+            "in": "query",
+            "required": true,
+            "style": "form",
+            "explode": true,
+            "schema": {
+              "$ref": "#/components/schemas/SiteId"
+            }
+          },
+          {
+            "name": "locale",
+            "in": "query",
+            "required": false,
+            "style": "form",
+            "explode": true,
+            "schema": {
+              "$ref": "#/components/schemas/LocaleCode"
+            }
+          },
+          {
+            "name": "tags",
+            "in": "query",
+            "required": false,
+            "style": "form",
+            "explode": false,
+            "schema": {
+              "type": "array",
+              "items": {
+                "$ref": "#/components/schemas/Tag"
+              },
+              "maxItems": 10,
+              "minItems": 0
+            }
+          },
+          {
+            "name": "expand",
+            "in": "query",
+            "required": false,
+            "style": "form",
+            "explode": false,
+            "schema": {
+              "type": "array",
+              "default": [],
+              "items": {
+                "type": "string",
+                "enum": [
+                  "consentStatus"
+                ]
+              },
+              "maxItems": 10,
+              "minItems": 0,
+              "uniqueItems": true
+            }
+          },
+          {
+            "name": "sfdc_usid",
+            "in": "header",
+            "required": false,
+            "style": "simple",
+            "explode": false,
+            "schema": {
+              "type": "string",
+              "format": "uuid"
+            }
+          },
+          {
+            "name": "sfdc_dw_dnt",
+            "in": "header",
+            "required": false,
+            "style": "simple",
+            "explode": false,
+            "schema": {
+              "type": "string",
+              "enum": [
+                "0",
+                "1"
+              ]
+            }
+          },
+          {
+            "name": "personalized",
+            "in": "query",
+            "required": false,
+            "style": "form",
+            "explode": true,
+            "schema": {
+              "type": "string",
+              "enum": [
+                "none"
+              ]
+            }
+          },
+          {
+            "name": "sfdc_shopper_context",
+            "in": "header",
+            "required": false,
+            "style": "simple",
+            "explode": false,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Successfully retrieved subscription preferences.\n",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ConsentSubscriptionResponse"
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Error retrieving subscription preferences\n",
+            "content": {
+              "application/problem+json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            }
+          }
+        },
+        "security": [
+          {
+            "ShopperToken": [
+              "sfcc.shopper-consents",
+              "sfcc.shopper-consents.rw"
+            ]
+          },
+          {
+            "ShopperClientContextToken": [
+              "sfcc.shopper-consents",
+              "sfcc.shopper-consents.rw"
+            ]
+          }
+        ]
+      },
+      "post": {
+        "operationId": "updateSubscription",
+        "parameters": [
+          {
+            "name": "organizationId",
+            "in": "path",
+            "required": true,
+            "style": "simple",
+            "explode": false,
+            "schema": {
+              "$ref": "#/components/schemas/OrganizationId"
+            }
+          },
+          {
+            "name": "siteId",
+            "in": "query",
+            "required": true,
+            "style": "form",
+            "explode": true,
+            "schema": {
+              "$ref": "#/components/schemas/SiteId"
+            }
+          },
+          {
+            "name": "locale",
+            "in": "query",
+            "required": false,
+            "style": "form",
+            "explode": true,
+            "schema": {
+              "$ref": "#/components/schemas/LocaleCode"
+            }
+          },
+          {
+            "name": "sfdc_usid",
+            "in": "header",
+            "required": false,
+            "style": "simple",
+            "explode": false,
+            "schema": {
+              "type": "string",
+              "format": "uuid"
+            }
+          },
+          {
+            "name": "sfdc_dw_dnt",
+            "in": "header",
+            "required": false,
+            "style": "simple",
+            "explode": false,
+            "schema": {
+              "type": "string",
+              "enum": [
+                "0",
+                "1"
+              ]
+            }
+          },
+          {
+            "name": "sfdc_shopper_context",
+            "in": "header",
+            "required": false,
+            "style": "simple",
+            "explode": false,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/ConsentSubscriptionRequest"
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "200": {
+            "description": "Subscription update completed successfully.\n",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ConsentSubscriptionUpdateResponse"
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Error with request format or validation\n",
+            "content": {
+              "application/problem+json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            }
+          }
+        },
+        "security": [
+          {
+            "ShopperToken": [
+              "sfcc.shopper-consents.rw"
+            ]
+          },
+          {
+            "ShopperClientContextToken": [
+              "sfcc.shopper-consents.rw"
+            ]
+          }
+        ]
+      }
+    },
+    "/organizations/{organizationId}/subscriptions/actions/bulk": {
+      "post": {
+        "operationId": "updateSubscriptions",
+        "parameters": [
+          {
+            "name": "organizationId",
+            "in": "path",
+            "required": true,
+            "style": "simple",
+            "explode": false,
+            "schema": {
+              "$ref": "#/components/schemas/OrganizationId"
+            }
+          },
+          {
+            "name": "siteId",
+            "in": "query",
+            "required": true,
+            "style": "form",
+            "explode": true,
+            "schema": {
+              "$ref": "#/components/schemas/SiteId"
+            }
+          },
+          {
+            "name": "locale",
+            "in": "query",
+            "required": false,
+            "style": "form",
+            "explode": true,
+            "schema": {
+              "$ref": "#/components/schemas/LocaleCode"
+            }
+          },
+          {
+            "name": "sfdc_usid",
+            "in": "header",
+            "required": false,
+            "style": "simple",
+            "explode": false,
+            "schema": {
+              "type": "string",
+              "format": "uuid"
+            }
+          },
+          {
+            "name": "sfdc_dw_dnt",
+            "in": "header",
+            "required": false,
+            "style": "simple",
+            "explode": false,
+            "schema": {
+              "type": "string",
+              "enum": [
+                "0",
+                "1"
+              ]
+            }
+          },
+          {
+            "name": "sfdc_shopper_context",
+            "in": "header",
+            "required": false,
+            "style": "simple",
+            "explode": false,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/ConsentSubscriptionBulkRequest"
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "200": {
+            "description": "All subscription updates completed successfully.\n",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ConsentSubscriptionBulkResponse"
+                }
+              }
+            }
+          },
+          "207": {
+            "description": "Partial success - some subscription updates succeeded, others failed.\n",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ConsentSubscriptionBulkResponse"
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Error with bulk request format or validation\n",
+            "content": {
+              "application/problem+json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            }
+          }
+        },
+        "security": [
+          {
+            "ShopperToken": [
+              "sfcc.shopper-consents.rw"
+            ]
+          },
+          {
+            "ShopperClientContextToken": [
+              "sfcc.shopper-consents.rw"
+            ]
+          }
+        ]
+      }
+    }
+  },
+  "components": {
+    "schemas": {
+      "OrganizationId": {
+        "type": "string",
+        "pattern": "^f_ecom_[a-z]{4}_(prd|stg|dev|s[0-9]{2}|[0-9]{3})$"
+      },
+      "SiteId": {
+        "type": "string",
+        "maxLength": 32,
+        "minLength": 1
+      },
+      "LanguageCountry": {
+        "type": "string",
+        "pattern": "^[a-z][a-z]-[A-Z][A-Z]$"
+      },
+      "LanguageCode": {
+        "type": "string",
+        "pattern": "^[a-z][a-z]$"
+      },
+      "DefaultFallback": {
+        "type": "string",
+        "default": "default",
+        "pattern": "^default$"
+      },
+      "LocaleCode": {
+        "oneOf": [
+          {
+            "$ref": "#/components/schemas/LanguageCountry"
+          },
+          {
+            "$ref": "#/components/schemas/LanguageCode"
+          },
+          {
+            "$ref": "#/components/schemas/DefaultFallback"
+          }
+        ]
+      },
+      "Tag": {
+        "type": "string",
+        "maxLength": 256,
+        "minLength": 1
+      },
+      "SubscriptionId": {
+        "type": "string",
+        "maxLength": 255,
+        "minLength": 1,
+        "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
+      },
+      "ChannelType": {
+        "type": "string",
+        "enum": [
+          "email",
+          "sms",
+          "whatsapp"
+        ]
+      },
+      "SubscriptionChannel": {
+        "type": "array",
+        "items": {
+          "$ref": "#/components/schemas/ChannelType"
+        },
+        "maxItems": 3,
+        "minItems": 1,
+        "uniqueItems": true
+      },
+      "ContactPointValue": {
+        "type": "string",
+        "maxLength": 320,
+        "minLength": 3
+      },
+      "ConsentStatus": {
+        "type": "string",
+        "enum": [
+          "opt_in",
+          "opt_out"
+        ]
+      },
+      "SubscriptionStatusEntry": {
+        "type": "object",
+        "additionalProperties": false,
+        "properties": {
+          "channel": {
+            "$ref": "#/components/schemas/ChannelType"
+          },
+          "contactPointValue": {
+            "$ref": "#/components/schemas/ContactPointValue"
+          },
+          "status": {
+            "$ref": "#/components/schemas/ConsentStatus"
+          }
+        },
+        "required": [
+          "channel",
+          "contactPointValue",
+          "status"
+        ]
+      },
+      "SubscriptionStatusArray": {
+        "type": "array",
+        "items": {
+          "$ref": "#/components/schemas/SubscriptionStatusEntry"
+        },
+        "maxItems": 10,
+        "minItems": 0
+      },
+      "SubscriptionTitle": {
+        "type": "string",
+        "maxLength": 255,
+        "minLength": 1
+      },
+      "SubscriptionSubtitle": {
+        "type": "string",
+        "maxLength": 2000,
+        "minLength": 1
+      },
+      "ConsentSubscription": {
+        "type": "object",
+        "properties": {
+          "subscriptionId": {
+            "$ref": "#/components/schemas/SubscriptionId"
+          },
+          "channels": {
+            "$ref": "#/components/schemas/SubscriptionChannel"
+          },
+          "consentStatus": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/SubscriptionStatusArray"
+              }
+            ]
+          },
+          "title": {
+            "$ref": "#/components/schemas/SubscriptionTitle"
+          },
+          "subtitle": {
+            "$ref": "#/components/schemas/SubscriptionSubtitle"
+          },
+          "tags": {
+            "type": "array",
+            "default": [],
+            "items": {
+              "$ref": "#/components/schemas/Tag"
+            },
+            "maxItems": 10,
+            "minItems": 0
+          },
+          "consentType": {
+            "type": "string",
+            "default": "marketing",
+            "enum": [
+              "marketing",
+              "legal"
+            ]
+          },
+          "consentRequired": {
+            "type": "boolean",
+            "default": false
+          },
+          "defaultStatus": {
+            "type": "string",
+            "default": "opt_out",
+            "enum": [
+              "opt_in",
+              "opt_out"
+            ]
+          }
+        },
+        "required": [
+          "channels",
+          "subscriptionId"
+        ]
+      },
+      "ConsentSubscriptionResponse": {
+        "type": "object",
+        "properties": {
+          "data": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/ConsentSubscription"
+            },
+            "maxItems": 50,
+            "minItems": 0
+          }
+        },
+        "required": [
+          "data"
+        ]
+      },
+      "ErrorResponse": {
+        "type": "object",
+        "additionalProperties": true,
+        "properties": {
+          "title": {
+            "type": "string",
+            "maxLength": 256
+          },
+          "type": {
+            "type": "string",
+            "maxLength": 2048
+          },
+          "detail": {
+            "type": "string"
+          },
+          "instance": {
+            "type": "string",
+            "maxLength": 2048
+          }
+        },
+        "required": [
+          "detail",
+          "title",
+          "type"
+        ]
+      },
+      "ConsentSubscriptionRequest": {
+        "type": "object",
+        "properties": {
+          "subscriptionId": {
+            "$ref": "#/components/schemas/SubscriptionId"
+          },
+          "contactPointValue": {
+            "$ref": "#/components/schemas/ContactPointValue"
+          },
+          "channel": {
+            "$ref": "#/components/schemas/ChannelType"
+          },
+          "status": {
+            "$ref": "#/components/schemas/ConsentStatus"
+          }
+        },
+        "required": [
+          "channel",
+          "contactPointValue",
+          "status",
+          "subscriptionId"
+        ]
+      },
+      "ConsentSubscriptionUpdateResponse": {
+        "type": "object",
+        "properties": {
+          "subscriptionId": {
+            "$ref": "#/components/schemas/SubscriptionId"
+          },
+          "channel": {
+            "$ref": "#/components/schemas/ChannelType"
+          },
+          "contactPointValue": {
+            "$ref": "#/components/schemas/ContactPointValue"
+          },
+          "status": {
+            "$ref": "#/components/schemas/ConsentStatus"
+          }
+        },
+        "required": [
+          "channel",
+          "contactPointValue",
+          "status",
+          "subscriptionId"
+        ]
+      },
+      "ConsentSubscriptionBulkRequest": {
+        "type": "object",
+        "properties": {
+          "subscriptions": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/ConsentSubscriptionRequest"
+            },
+            "maxItems": 50,
+            "minItems": 1
+          }
+        },
+        "required": [
+          "subscriptions"
+        ]
+      },
+      "ConsentSubscriptionError": {
+        "type": "object",
+        "properties": {
+          "code": {
+            "type": "string",
+            "maxLength": 100
+          },
+          "message": {
+            "type": "string",
+            "maxLength": 500
+          },
+          "details": {
+            "type": "object",
+            "additionalProperties": false
+          }
+        },
+        "required": [
+          "code",
+          "message"
+        ]
+      },
+      "ConsentSubscriptionResult": {
+        "type": "object",
+        "properties": {
+          "subscriptionId": {
+            "$ref": "#/components/schemas/SubscriptionId"
+          },
+          "channel": {
+            "$ref": "#/components/schemas/ChannelType"
+          },
+          "contactPointValue": {
+            "$ref": "#/components/schemas/ContactPointValue"
+          },
+          "status": {
+            "$ref": "#/components/schemas/ConsentStatus"
+          },
+          "success": {
+            "type": "boolean"
+          },
+          "error": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/ConsentSubscriptionError"
+              }
+            ]
+          }
+        },
+        "required": [
+          "channel",
+          "contactPointValue",
+          "status",
+          "subscriptionId",
+          "success"
+        ]
+      },
+      "ConsentSubscriptionBulkResponse": {
+        "type": "object",
+        "properties": {
+          "results": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/ConsentSubscriptionResult"
+            }
+          }
+        },
+        "required": [
+          "results"
+        ]
+      }
+    },
+    "parameters": {
+      "organizationId": {
+        "name": "organizationId",
+        "in": "path",
+        "required": true,
+        "style": "simple",
+        "explode": false,
+        "schema": {
+          "$ref": "#/components/schemas/OrganizationId"
+        }
+      },
+      "siteId": {
+        "name": "siteId",
+        "in": "query",
+        "required": true,
+        "style": "form",
+        "explode": true,
+        "schema": {
+          "$ref": "#/components/schemas/SiteId"
+        }
+      },
+      "locale": {
+        "name": "locale",
+        "in": "query",
+        "required": false,
+        "style": "form",
+        "explode": true,
+        "schema": {
+          "$ref": "#/components/schemas/LocaleCode"
+        }
+      },
+      "tags": {
+        "name": "tags",
+        "in": "query",
+        "required": false,
+        "style": "form",
+        "explode": false,
+        "schema": {
+          "type": "array",
+          "items": {
+            "$ref": "#/components/schemas/Tag"
+          },
+          "maxItems": 10,
+          "minItems": 0
+        }
+      },
+      "expand": {
+        "name": "expand",
+        "in": "query",
+        "required": false,
+        "style": "form",
+        "explode": false,
+        "schema": {
+          "type": "array",
+          "default": [],
+          "items": {
+            "type": "string",
+            "enum": [
+              "consentStatus"
+            ]
+          },
+          "maxItems": 10,
+          "minItems": 0,
+          "uniqueItems": true
+        }
+      },
+      "sfdcUsid": {
+        "name": "sfdc_usid",
+        "in": "header",
+        "required": false,
+        "style": "simple",
+        "explode": false,
+        "schema": {
+          "type": "string",
+          "format": "uuid"
+        }
+      },
+      "sfdcDwDnt": {
+        "name": "sfdc_dw_dnt",
+        "in": "header",
+        "required": false,
+        "style": "simple",
+        "explode": false,
+        "schema": {
+          "type": "string",
+          "enum": [
+            "0",
+            "1"
+          ]
+        }
+      },
+      "personalized": {
+        "name": "personalized",
+        "in": "query",
+        "required": false,
+        "style": "form",
+        "explode": true,
+        "schema": {
+          "type": "string",
+          "enum": [
+            "none"
+          ]
+        }
+      },
+      "sfdcShopperContext": {
+        "name": "sfdc_shopper_context",
+        "in": "header",
+        "required": false,
+        "style": "simple",
+        "explode": false,
+        "schema": {
+          "type": "string"
+        }
+      }
+    },
+    "securitySchemes": {
+      "ShopperToken": {
+        "type": "oauth2",
+        "flows": {
+          "clientCredentials": {
+            "tokenUrl": "https://{shortCode}.api.commercecloud.salesforce.com/shopper/auth/v1/organizations/{organizationId}/oauth2/token",
+            "scopes": {
+              "sfcc.shopper-consents": "Allows read operations on shopper consents",
+              "sfcc.shopper-consents.rw": "Allows read/write operations on shopper consents"
+            }
+          },
+          "authorizationCode": {
+            "authorizationUrl": "https://{shortCode}.api.commercecloud.salesforce.com/shopper/auth/v1/organizations/{organizationId}/oauth2/authorize",
+            "tokenUrl": "https://{shortCode}.api.commercecloud.salesforce.com/shopper/auth/v1/organizations/{organizationId}/oauth2/token",
+            "scopes": {
+              "sfcc.shopper-consents": "Allows read operations on shopper consents",
+              "sfcc.shopper-consents.rw": "Allows read/write operations on shopper consents"
+            }
+          }
+        }
+      },
+      "ShopperClientContextToken": {
+        "type": "oauth2",
+        "flows": {
+          "clientCredentials": {
+            "tokenUrl": "https://{shortCode}.api.commercecloud.salesforce.com/shopper/auth/v1/organizations/{organizationId}/oauth2/token?hint=client_context",
+            "scopes": {
+              "sfcc.shopper-consents": "Allows read operations on shopper consents",
+              "sfcc.shopper-consents.rw": "Allows read/write operations on shopper consents"
+            }
+          }
+        }
+      }
+    }
+  }
+}