NormalizeConfigJsonApiModelCreate

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/gtm/main/json-schema/gtm-normalize-config-json-api-model-create-schema.json",
  "title": "NormalizeConfigJsonApiModelCreate",
  "description": "JSON API model for a single normalization config.",
  "x-generated": "2026-10-20",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/gtm-data-quality-api-v1-api-openapi.yml#/components/schemas/NormalizeConfigJsonApiModelCreate",
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "allOf": [
        {
          "$ref": "#/$defs/NormalizeConfigCreate"
        }
      ],
      "description": "The primary data of the document"
    }
  },
  "$defs": {
    "CityRule": {
      "type": "object",
      "required": [
        "type",
        "value"
      ],
      "properties": {
        "type": {
          "allOf": [
            {
              "$ref": "#/$defs/CityRuleType"
            }
          ],
          "description": "The city normalization rule to apply."
        },
        "value": {
          "allOf": [
            {
              "$ref": "#/$defs/CityRuleValue"
            }
          ],
          "description": "The value parameter for the rule."
        }
      },
      "description": "A single city normalization rule. Use only the documented `type`/`value` combinations."
    },
    "CityRuleType": {
      "type": "string",
      "enum": [
        "CASE",
        "PREFIXES",
        "PERIODS"
      ],
      "description": "City normalization rule names.",
      "x-enumDescriptions": {
        "CASE": "Letter casing of the city name.",
        "PREFIXES": "Prefix-token handling.",
        "PERIODS": "Period handling."
      }
    },
    "CityRuleValue": {
      "type": "string",
      "enum": [
        "NONE",
        "PROPER_CASE",
        "UPPERCASE",
        "LOWERCASE",
        "ABBREVIATE",
        "EXPAND",
        "ADD",
        "REMOVE"
      ],
      "description": "Legal values for city normalization rules. Valid combinations: `CASE` -> `PROPER_CASE|UPPERCASE|LOWERCASE`; `PREFIXES` -> `ABBREVIATE|EXPAND`; `PERIODS` -> `ADD|REMOVE`; any rule type may use `NONE`.",
      "x-enumDescriptions": {
        "NONE": "Leave unchanged.",
        "PROPER_CASE": "Proper (title) case (`CASE`).",
        "UPPERCASE": "Uppercase (`CASE`).",
        "LOWERCASE": "Lowercase (`CASE`).",
        "ABBREVIATE": "Abbreviate the prefix (`PREFIXES`).",
        "EXPAND": "Expand the prefix (`PREFIXES`).",
        "ADD": "Add periods (`PERIODS`).",
        "REMOVE": "Remove periods (`PERIODS`)."
      }
    },
    "CountryRule": {
      "type": "object",
      "required": [
        "type",
        "value"
      ],
      "properties": {
        "type": {
          "allOf": [
            {
              "$ref": "#/$defs/CountryRuleType"
            }
          ],
          "description": "The country normalization rule to apply."
        },
        "value": {
          "allOf": [
            {
              "$ref": "#/$defs/CountryRuleValue"
            }
          ],
          "description": "The value parameter for the rule."
        }
      },
      "description": "A single country normalization rule. Use only the documented `type`/`value` combinations."
    },
    "CountryRuleType": {
      "type": "string",
      "enum": [
        "COUNTRY_NAME",
        "COUNTRY_CODE"
      ],
      "description": "Country normalization rule names.",
      "x-enumDescriptions": {
        "COUNTRY_NAME": "Country-name representation.",
        "COUNTRY_CODE": "Country-code representation."
      }
    },
    "CountryRuleValue": {
      "type": "string",
      "enum": [
        "NONE",
        "COMMON_NAME",
        "SHORT_NAME",
        "LONG_NAME",
        "ES_NAME",
        "FR_NAME",
        "CH_NAME",
        "AR_NAME",
        "RU_NAME",
        "ALPHA2",
        "ALPHA3",
        "NUMERIC_CODE"
      ],
      "description": "Legal values for country normalization rules. Valid combinations: `COUNTRY_NAME` -> `COMMON_NAME|SHORT_NAME|LONG_NAME|ES_NAME|FR_NAME|CH_NAME|AR_NAME|RU_NAME|ALPHA2|ALPHA3|NUMERIC_CODE`; `COUNTRY_CODE` -> `ALPHA2|ALPHA3|NUMERIC_CODE`; any rule type may use `NONE`.",
      "x-enumDescriptions": {
        "NONE": "Leave unchanged.",
        "COMMON_NAME": "Common name (`COUNTRY_NAME`).",
        "SHORT_NAME": "Short name (`COUNTRY_NAME`).",
        "LONG_NAME": "Long name (`COUNTRY_NAME`).",
        "ES_NAME": "Spanish name (`COUNTRY_NAME`).",
        "FR_NAME": "French name (`COUNTRY_NAME`).",
        "CH_NAME": "Chinese name (`COUNTRY_NAME`).",
        "AR_NAME": "Arabic name (`COUNTRY_NAME`).",
        "RU_NAME": "Russian name (`COUNTRY_NAME`).",
        "ALPHA2": "ISO 3166-1 alpha-2 code (`COUNTRY_NAME`, `COUNTRY_CODE`).",
        "ALPHA3": "ISO 3166-1 alpha-3 code (`COUNTRY_NAME`, `COUNTRY_CODE`).",
        "NUMERIC_CODE": "ISO 3166-1 numeric code (`COUNTRY_NAME`, `COUNTRY_CODE`)."
      }
    },
    "JobTitleRule": {
      "type": "object",
      "required": [
        "type",
        "value"
      ],
      "properties": {
        "type": {
          "allOf": [
            {
              "$ref": "#/$defs/JobTitleRuleType"
            }
          ],
          "description": "The job-title normalization rule to apply."
        },
        "value": {
          "allOf": [
            {
              "$ref": "#/$defs/JobTitleRuleValue"
            }
          ],
          "description": "The value parameter for the rule."
        }
      },
      "description": "A single job-title normalization rule. Use only the documented `type`/`value` combinations."
    },
    "JobTitleRuleType": {
      "type": "string",
      "enum": [
        "CASE",
        "PERIODS",
        "COMMAS",
        "DEPARTMENT_LITERAL",
        "DEPARTMENT_NAMES",
        "ORDER",
        "CXO",
        "VP",
        "DIRECTOR",
        "MANAGER",
        "MODIFIER_PREFIXES",
        "MODIFIER_SUFFIXES",
        "OF_USAGE",
        "AND_USAGE",
        "HYPHENS"
      ],
      "description": "Job-title normalization rule names.",
      "x-enumDescriptions": {
        "CASE": "Letter casing of the title.",
        "PERIODS": "Period handling.",
        "COMMAS": "Comma handling.",
        "DEPARTMENT_LITERAL": "Department-literal token handling.",
        "DEPARTMENT_NAMES": "Department-name token handling.",
        "ORDER": "Ordering of the department relative to the title.",
        "CXO": "CxO token handling (for example, `Chief Executive Officer`/`CEO`).",
        "VP": "Vice-president token handling.",
        "DIRECTOR": "Director token handling.",
        "MANAGER": "Manager token handling.",
        "MODIFIER_PREFIXES": "Modifier-prefix token handling.",
        "MODIFIER_SUFFIXES": "Modifier-suffix token handling.",
        "OF_USAGE": "Handling of the word `of`.",
        "AND_USAGE": "Handling of the word `and` / ampersand.",
        "HYPHENS": "Hyphen handling."
      }
    },
    "JobTitleRuleValue": {
      "type": "string",
      "enum": [
        "NONE",
        "PROPER_CASE",
        "UPPERCASE",
        "LOWERCASE",
        "ADD",
        "REMOVE",
        "ABBREVIATE",
        "EXPAND",
        "DEPARTMENT_LAST",
        "DEPARTMENT_FIRST",
        "CONVERT_TO_COMMA",
        "CONVERT_TO_HYPHEN",
        "CONVERT_TO_AND",
        "CONVERT_TO_AMPERSAND",
        "REMOVE_SPACE",
        "PAD_WITH_SPACE"
      ],
      "description": "Legal values for job-title normalization rules. Valid combinations: `CASE` -> `PROPER_CASE|UPPERCASE|LOWERCASE`; `PERIODS` -> `ADD|REMOVE`; `COMMAS|MODIFIER_SUFFIXES` -> `REMOVE`; `DEPARTMENT_LITERAL|DEPARTMENT_NAMES|CXO|VP|DIRECTOR|MANAGER|MODIFIER_PREFIXES` -> `ABBREVIATE|EXPAND`; `ORDER` -> `DEPARTMENT_LAST|DEPARTMENT_FIRST`; `OF_USAGE` -> `REMOVE|CONVERT_TO_COMMA|CONVERT_TO_HYPHEN`; `AND_USAGE` -> `CONVERT_TO_AND|CONVERT_TO_AMPERSAND`; `HYPHENS` -> `REMOVE|REMOVE_SPACE|PAD_WITH_SPACE`; any rule type may use `NONE`.",
      "x-enumDescriptions": {
        "NONE": "Leave unchanged.",
        "PROPER_CASE": "Proper (title) case (`CASE`).",
        "UPPERCASE": "Uppercase (`CASE`).",
        "LOWERCASE": "Lowercase (`CASE`).",
        "ADD": "Add (`PERIODS`).",
        "REMOVE": "Remove (`PERIODS`, `COMMAS`, `MODIFIER_SUFFIXES`, `OF_USAGE`, `HYPHENS`).",
        "ABBREVIATE": "Abbreviate the token (`DEPARTMENT_LITERAL`, `DEPARTMENT_NAMES`, `CXO`, `VP`, `DIRECTOR`, `MANAGER`, `MODIFIER_PREFIXES`).",
        "EXPAND": "Expand the token (`DEPARTMENT_LITERAL`, `DEPARTMENT_NAMES`, `CXO`, `VP`, `DIRECTOR`, `MANAGER`, `MODIFIER_PREFIXES`).",
        "DEPARTMENT_LAST": "Place the department last (`ORDER`).",
        "DEPARTMENT_FIRST": "Place the department first (`ORDER`).",
        "CONVERT_TO_COMMA": "Convert to a comma (`OF_USAGE`).",
        "CONVERT_TO_HYPHEN": "Convert to a hyphen (`OF_USAGE`).",
        "CONVERT_TO_AND": "Convert to the word `and` (`AND_USAGE`).",
        "CONVERT_TO_AMPERSAND": "Convert to an ampersand (`AND_USAGE`).",
        "REMOVE_SPACE": "Remove surrounding space (`HYPHENS`).",
        "PAD_WITH_SPACE": "Pad with surrounding space (`HYPHENS`)."
      }
    },
    "NormalizeConfigAttributesCreate": {
      "type": "object",
      "required": [
        "name",
        "rules"
      ],
      "properties": {
        "name": {
          "type": "string",
          "description": "Display name for the config."
        },
        "description": {
          "type": "string",
          "description": "Optional human-readable description of what the config does."
        },
        "rules": {
          "allOf": [
            {
              "$ref": "#/$defs/NormalizeConfigRules"
            }
          ],
          "description": "Custom-normalization rules for this config, grouped by rule group."
        }
      },
      "description": "Attributes of a normalization configuration."
    },
    "NormalizeConfigCreate": {
      "type": "object",
      "required": [
        "type",
        "attributes"
      ],
      "properties": {
        "type": {
          "type": "string",
          "description": "The type of the resource",
          "default": "NormalizeConfig",
          "pattern": "NormalizeConfig"
        },
        "attributes": {
          "allOf": [
            {
              "$ref": "#/$defs/NormalizeConfigAttributesCreate"
            }
          ],
          "description": "The attributes defining the resource"
        }
      },
      "description": "A normalization configuration resource."
    },
    "NormalizeConfigRules": {
      "type": "object",
      "properties": {
        "phone": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/PhoneRule"
          },
          "description": "Rules applied to the phone number."
        },
        "streetLine": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/StreetLineRule"
          },
          "description": "Rules applied to the street line(s)."
        },
        "city": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/CityRule"
          },
          "description": "Rules applied to the city."
        },
        "stateProvince": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/StateProvinceRule"
          },
          "description": "Rules applied to the state/province."
        },
        "country": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/CountryRule"
          },
          "description": "Rules applied to the country."
        },
        "jobTitle": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/JobTitleRule"
          },
          "description": "Rules applied to the job title."
        },
        "personName": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/PersonNameRule"
          },
          "description": "Rules applied to the person name."
        }
      },
      "description": "Custom-normalization rules for a stored config, grouped by rule group. A single config may carry\nrules for any combination of domains. Each group is an ordered list of `type`/`value` rules; use\nonly the documented `type`/`value` combinations (see each rule model). Email has no rule\nvocabulary and therefore no group here."
    },
    "PersonNameRule": {
      "type": "object",
      "required": [
        "type",
        "value"
      ],
      "properties": {
        "type": {
          "allOf": [
            {
              "$ref": "#/$defs/PersonNameRuleType"
            }
          ],
          "description": "The person-name normalization rule to apply."
        },
        "value": {
          "allOf": [
            {
              "$ref": "#/$defs/PersonNameRuleValue"
            }
          ],
          "description": "The value parameter for the rule."
        }
      },
      "description": "A single person-name normalization rule. Use only the documented `type`/`value` combinations."
    },
    "PersonNameRuleType": {
      "type": "string",
      "enum": [
        "CASE",
        "FIRST_NAME",
        "MIDDLE_NAME",
        "PREFIXES",
        "SUFFIXES",
        "PERIODS_INITIALS",
        "PERIODS_PREFIXES",
        "HYPHENS"
      ],
      "description": "Person-name normalization rule names.",
      "x-enumDescriptions": {
        "CASE": "Letter casing of the name.",
        "FIRST_NAME": "First-name handling.",
        "MIDDLE_NAME": "Middle-name handling.",
        "PREFIXES": "Prefix-token handling (for example, `Dr`, `Ms`).",
        "SUFFIXES": "Suffix-token handling (for example, `Jr`, `III`).",
        "PERIODS_INITIALS": "Period handling for initials.",
        "PERIODS_PREFIXES": "Period handling for prefixes.",
        "HYPHENS": "Hyphen handling."
      }
    },
    "PersonNameRuleValue": {
      "type": "string",
      "enum": [
        "NONE",
        "PROPER_CASE",
        "UPPERCASE",
        "LOWERCASE",
        "CONVERT_TO_INITIAL",
        "ADD",
        "REMOVE"
      ],
      "description": "Legal values for person-name normalization rules. Valid combinations: `CASE` -> `PROPER_CASE|UPPERCASE|LOWERCASE`; `FIRST_NAME` -> `CONVERT_TO_INITIAL`; `MIDDLE_NAME` -> `CONVERT_TO_INITIAL|REMOVE`; `PREFIXES|SUFFIXES|HYPHENS` -> `REMOVE`; `PERIODS_INITIALS|PERIODS_PREFIXES` -> `ADD|REMOVE`; any rule type may use `NONE`.",
      "x-enumDescriptions": {
        "NONE": "Leave unchanged.",
        "PROPER_CASE": "Proper (title) case (`CASE`).",
        "UPPERCASE": "Uppercase (`CASE`).",
        "LOWERCASE": "Lowercase (`CASE`).",
        "CONVERT_TO_INITIAL": "Convert to a single initial (`FIRST_NAME`, `MIDDLE_NAME`).",
        "ADD": "Add the element (`PERIODS_INITIALS`, `PERIODS_PREFIXES`).",
        "REMOVE": "Remove the element (`MIDDLE_NAME`, `PREFIXES`, `SUFFIXES`, `PERIODS_INITIALS`, `PERIODS_PREFIXES`, `HYPHENS`)."
      }
    },
    "PhoneRule": {
      "type": "object",
      "required": [
        "type",
        "value"
      ],
      "properties": {
        "type": {
          "allOf": [
            {
              "$ref": "#/$defs/PhoneRuleType"
            }
          ],
          "description": "The phone normalization rule to apply."
        },
        "value": {
          "allOf": [
            {
              "$ref": "#/$defs/PhoneRuleValue"
            }
          ],
          "description": "The value parameter for the rule."
        }
      },
      "description": "A single phone normalization rule. `type` selects the rule; `value` is its argument. Use only the documented `type`/`value` combinations."
    },
    "PhoneRuleType": {
      "type": "string",
      "enum": [
        "INT_FORMAT",
        "LEADING_1",
        "AREA_CODE_PARENTHESES",
        "AREA_CODE_PADDING",
        "SEPARATOR"
      ],
      "description": "Phone normalization rule names.",
      "x-enumDescriptions": {
        "INT_FORMAT": "International formatting style applied to the number.",
        "LEADING_1": "Handling of a leading country/trunk `1`.",
        "AREA_CODE_PARENTHESES": "Parentheses around the area code.",
        "AREA_CODE_PADDING": "Padding around the area code.",
        "SEPARATOR": "Separator character between number groups."
      }
    },
    "PhoneRuleValue": {
      "type": "string",
      "enum": [
        "NONE",
        "REMOVE",
        "ADD",
        "INTERNATIONAL",
        "NATIONAL",
        "E164",
        "RFC3966",
        "CONVERT_TO_PLUS_ONE",
        "DASH",
        "DOT",
        "SPACE"
      ],
      "description": "Legal values for phone normalization rules. Valid combinations: `INT_FORMAT` -> `INTERNATIONAL|NATIONAL|E164|RFC3966`; `LEADING_1` -> `ADD|REMOVE|CONVERT_TO_PLUS_ONE`; `SEPARATOR` -> `REMOVE|DASH|DOT|SPACE`; `AREA_CODE_PARENTHESES|AREA_CODE_PADDING` -> `ADD|REMOVE`; any rule type may use `NONE`.",
      "x-enumDescriptions": {
        "NONE": "Leave unchanged.",
        "REMOVE": "Remove the element.",
        "ADD": "Add the element.",
        "INTERNATIONAL": "International format (`INT_FORMAT`).",
        "NATIONAL": "National format (`INT_FORMAT`).",
        "E164": "E.164 format (`INT_FORMAT`).",
        "RFC3966": "RFC 3966 format (`INT_FORMAT`).",
        "CONVERT_TO_PLUS_ONE": "Convert a leading `1` to `+1` (`LEADING_1`).",
        "DASH": "Use a dash separator (`SEPARATOR`).",
        "DOT": "Use a dot separator (`SEPARATOR`).",
        "SPACE": "Use a space separator (`SEPARATOR`)."
      }
    },
    "StateProvinceRule": {
      "type": "object",
      "required": [
        "type",
        "value"
      ],
      "properties": {
        "type": {
          "allOf": [
            {
              "$ref": "#/$defs/StateProvinceRuleType"
            }
          ],
          "description": "The state/province normalization rule to apply."
        },
        "value": {
          "allOf": [
            {
              "$ref": "#/$defs/StateProvinceRuleValue"
            }
          ],
          "description": "The value parameter for the rule."
        }
      },
      "description": "A single state/province normalization rule. Use only the documented `type`/`value` combinations."
    },
    "StateProvinceRuleType": {
      "type": "string",
      "enum": [
        "CASE",
        "FORMAT"
      ],
      "description": "State/province normalization rule names.",
      "x-enumDescriptions": {
        "CASE": "Letter casing of the state/province.",
        "FORMAT": "Abbreviated vs. expanded form."
      }
    },
    "StateProvinceRuleValue": {
      "type": "string",
      "enum": [
        "NONE",
        "UPPERCASE",
        "LOWERCASE",
        "PROPER_CASE",
        "ABBREVIATE",
        "EXPAND"
      ],
      "description": "Legal values for state/province normalization rules. Valid combinations: `CASE` -> `UPPERCASE|LOWERCASE|PROPER_CASE`; `FORMAT` -> `ABBREVIATE|EXPAND`; any rule type may use `NONE`.",
      "x-enumDescriptions": {
        "NONE": "Leave unchanged.",
        "UPPERCASE": "Uppercase (`CASE`).",
        "LOWERCASE": "Lowercase (`CASE`).",
        "PROPER_CASE": "Proper (title) case (`CASE`).",
        "ABBREVIATE": "Abbreviated form, for example `NC` (`FORMAT`).",
        "EXPAND": "Expanded form, for example `North Carolina` (`FORMAT`)."
      }
    },
    "StreetLineRule": {
      "type": "object",
      "required": [
        "type",
        "value"
      ],
      "properties": {
        "type": {
          "allOf": [
            {
              "$ref": "#/$defs/StreetLineRuleType"
            }
          ],
          "description": "The street-line normalization rule to apply."
        },
        "value": {
          "allOf": [
            {
              "$ref": "#/$defs/StreetLineRuleValue"
            }
          ],
          "description": "The value parameter for the rule."
        }
      },
      "description": "A single street-line normalization rule. Use only the documented `type`/`value` combinations."
    },
    "StreetLineRuleType": {
      "type": "string",
      "enum": [
        "CASE",
        "MULTIPLE",
        "STREET_TYPE",
        "COMPASS_DIR",
        "UNIT_DESIGNATORS",
        "PERIODS"
      ],
      "description": "Street-line normalization rule names.",
      "x-enumDescriptions": {
        "CASE": "Letter casing of the street line.",
        "MULTIPLE": "Handling of multiple street lines.",
        "STREET_TYPE": "Street-type token handling (for example, `Street`/`St`).",
        "COMPASS_DIR": "Compass-direction token handling (for example, `North`/`N`).",
        "UNIT_DESIGNATORS": "Unit-designator token handling (for example, `Suite`/`Ste`).",
        "PERIODS": "Period handling."
      }
    },
    "StreetLineRuleValue": {
      "type": "string",
      "enum": [
        "NONE",
        "PROPER_CASE",
        "UPPERCASE",
        "LOWERCASE",
        "COMBINE_ON_SINGLE_LINE",
        "DISCARD_SECOND_LINE",
        "ABBREVIATE",
        "EXPAND",
        "ADD",
        "REMOVE"
      ],
      "description": "Legal values for street-line normalization rules. Valid combinations: `CASE` -> `PROPER_CASE|UPPERCASE|LOWERCASE`; `MULTIPLE` -> `COMBINE_ON_SINGLE_LINE|DISCARD_SECOND_LINE`; `STREET_TYPE|COMPASS_DIR|UNIT_DESIGNATORS` -> `ABBREVIATE|EXPAND`; `PERIODS` -> `ADD|REMOVE`; any rule type may use `NONE`.",
      "x-enumDescriptions": {
        "NONE": "Leave unchanged.",
        "PROPER_CASE": "Proper (title) case (`CASE`).",
        "UPPERCASE": "Uppercase (`CASE`).",
        "LOWERCASE": "Lowercase (`CASE`).",
        "COMBINE_ON_SINGLE_LINE": "Combine multiple lines onto one (`MULTIPLE`).",
        "DISCARD_SECOND_LINE": "Discard the second line (`MULTIPLE`).",
        "ABBREVIATE": "Abbreviate the token (`STREET_TYPE`, `COMPASS_DIR`, `UNIT_DESIGNATORS`).",
        "EXPAND": "Expand the token (`STREET_TYPE`, `COMPASS_DIR`, `UNIT_DESIGNATORS`).",
        "ADD": "Add periods (`PERIODS`).",
        "REMOVE": "Remove periods (`PERIODS`)."
      }
    }
  }
}