xdm/docs/reference/fieldgroups/profile/profile-user-account-details.schema.json at master · RussStringham/xdm · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
{
    "meta:license": [
        "Copyright 2020 Adobe Systems Incorporated. All rights reserved.",
        "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license",
        "you may not use this file except in compliance with the License. You may obtain a copy",
        "of the License at https://creativecommons.org/licenses/by/4.0/"
    ],
    "$id": "https://ns.adobe.com/xdm/mixins/profile/profile-user-account-details",
    "$schema": "http://json-schema.org/draft-06/schema#",
    "title": "User Account Details",
    "type": "object",
    "meta:extensible": true,
    "meta:abstract": true,
    "meta:tags": {
        "industry": [
            "retail",
            "financial_services",
            "travel_and_hospitality",
            "telecom",
            "automotive",
            "education",
            "health_and_life_sciences",
            "high_tech",
            "manufacturing",
            "media_and_entertainment",
            "public_sector"
        ]
    },
    "meta:intendedToExtend": [
        "https://ns.adobe.com/xdm/context/profile"
    ],
    "description": "",
    "definitions": {
        "user-account-details": {
            "properties": {
                "xdm:userAccount": {
                    "type": "object",
                    "description": "Loyalty details, preferences, login processes, and other account preferences.",
                    "properties": {
                        "xdm:ID": {
                            "title": "ID",
                            "type": "string",
                            "description": "Captures the user account ID.",
                            "meta:titleId": "profile-user-account-details##xdm:ID##title##41391",
                            "meta:descriptionId": "profile-user-account-details##xdm:ID##description##82501"
                        },
                        "xdm:contactDetails": {
                            "title": "Contact Details",
                            "$ref": "https://ns.adobe.com/xdm/context/profile-personal-details",
                            "description": "Extension of the Personal Profile data type.",
                            "meta:titleId": "profile-user-account-details##xdm:contactDetails##title##26091",
                            "meta:descriptionId": "profile-user-account-details##xdm:contactDetails##description##27541"
                        },
                        "xdm:startDate": {
                            "title": "Start Date",
                            "type": "string",
                            "format": "date-time",
                            "description": "Date when the account was opened.",
                            "meta:titleId": "profile-user-account-details##xdm:startDate##title##50411",
                            "meta:descriptionId": "profile-user-account-details##xdm:startDate##description##99481"
                        },
                        "xdm:status": {
                            "title": "Status",
                            "type": "string",
                            "enum": [
                                "active",
                                "inactive",
                                "disabled",
                                "other"
                            ],
                            "meta:enum": {
                                "active": "Active",
                                "inactive": "Inactive",
                                "disabled": "Disabled",
                                "other": "Other"
                            },
                            "description": "This should describe the current status of the account",
                            "meta:titleId": "profile-user-account-details##xdm:status##title##94491",
                            "meta:descriptionId": "profile-user-account-details##xdm:status##description##22261"
                        },
                        "xdm:accountType": {
                            "title": "Account Type",
                            "type": "string",
                            "description": "Captures the user account type, if applicable.",
                            "meta:titleId": "profile-user-account-details##xdm:accountType##title##23261",
                            "meta:descriptionId": "profile-user-account-details##xdm:accountType##description##9011"
                        },
                        "xdm:productPreferences": {
                            "title": "Product Preferences",
                            "type": "array",
                            "items": {
                                "type": "string"
                            },
                            "description": "Product, shopping, or experience preferences such as gender, color pref, seat/aisle, king/double bed, etc.",
                            "meta:titleId": "profile-user-account-details##xdm:productPreferences##title##82621",
                            "meta:descriptionId": "profile-user-account-details##xdm:productPreferences##description##23481"
                        },
                        "xdm:alertStatus": {
                            "title": "Alert Status",
                            "type": "boolean",
                            "description": "Captures whether or not alerts have been enabled for the account.",
                            "meta:titleId": "profile-user-account-details##xdm:alertStatus##title##56871",
                            "meta:descriptionId": "profile-user-account-details##xdm:alertStatus##description##35551"
                        },
                        "xdm:autopayStatus": {
                            "title": "Autopay Status",
                            "type": "boolean",
                            "description": "Captures whether or not the account has been enrolled in autopay.",
                            "meta:titleId": "profile-user-account-details##xdm:autopayStatus##title##32961",
                            "meta:descriptionId": "profile-user-account-details##xdm:autopayStatus##description##35841"
                        }
                    },
                    "meta:descriptionId": "profile-user-account-details##xdm:userAccount##description##71851"
                }
            }
        }
    },
    "allOf": [
        {
            "$ref": "#/definitions/user-account-details"
        }
    ],
    "meta:status": "stable",
    "meta:createdDate": "2021-02-19",
    "meta:titleId": "profile-user-account-details##title##84191",
    "meta:descriptionId": "profile-user-account-details##description##50141",
    "examples": [
        {
            "xdm:userAccount": {
                "xdm:ID": "X87321",
                "xdm:accountType": "personal"
            }
        }
    ]
}