Skip to content

StoreConfigTemplate ​

Type: schema

TypeScript Definition ​

typescript
StoreConfigTemplate: {{
            id?: $Read<string>;
            /** @enum {unknown} */
            template_type?: "terms-of-service" | "refund-policy" | "email" | "invoice" | "web-layer" | "whatsapp" | "chat" | "push-notification" | "webhook";
            name?: string;
            /** @description example - signup, order-confirmation, order-cancelled, order-refunded, cart-abandoned, etc. */
            activity?: string | null;
            /** @enum {unknown} */
            content_type?: "html" | "markdown" | "plaintext";
            description?: string | null;
            /** @description to be used in email subject or notification heading if provided. */
            content_title?: string | null;
        };
        /** StoreConfigWarehouse */
}

OpenAPI Schema ​

json
{
  "title": "StoreConfigTemplate",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "readOnly": true
    },
    "template_type": {
      "enum": [
        "terms-of-service",
        "refund-policy",
        "email",
        "invoice",
        "web-layer",
        "whatsapp",
        "chat",
        "push-notification",
        "webhook"
      ]
    },
    "name": {
      "type": "string"
    },
    "activity": {
      "description": "example - signup, order-confirmation, order-cancelled, order-refunded, cart-abandoned, etc.",
      "type": [
        "string",
        "null"
      ]
    },
    "content_type": {
      "enum": [
        "html",
        "markdown",
        "plaintext"
      ]
    },
    "description": {
      "type": [
        "string",
        "null"
      ]
    },
    "content_title": {
      "description": "to be used in email subject or notification heading if provided.",
      "type": [
        "string",
        "null"
      ]
    }
  },
  "x-tags": [
    "Store"
  ]
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: