xdm/docs/reference/fieldgroups/deprecated/experienceevent-autopay-enrollment-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
{
    "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/experienceevent-autopay-enrollment-details",
    "$schema": "http://json-schema.org/draft-06/schema#",
    "title": "Autopay Enrollment Details",
    "type": "object",
    "meta:extensible": true,
    "meta:abstract": true,
    "meta:tags": {
        "industry": [
            "retail",
            "financial_services",
            "telecom",
            "automotive",
            "education",
            "health_and_life_sciences",
            "media_and_entertainment"
        ]
    },
    "meta:intendedToExtend": [
        "https://ns.adobe.com/xdm/context/experienceevent"
    ],
    "description": "Autopay enrollment details such as autopay status, start, save, and failure.",
    "definitions": {
        "autopay-enrollment-details": {
            "properties": {
                "xdm:autopayEnrollment": {
                    "type": "object",
                    "properties": {
                        "xdm:autoPayEnrollment": {
                            "title": "Autopay Enrollment",
                            "$ref": "https://ns.adobe.com/xdm/datatypes/tool-usage",
                            "description": "Extension of toolUsage data type.",
                            "meta:titleId": "experienceevent-autopay-enrollment-details##xdm:autoPayEnrollment##title##25151",
                            "meta:descriptionId": "experienceevent-autopay-enrollment-details##xdm:autoPayEnrollment##description##37431"
                        },
                        "xdm:autoPayEnrollmentStatus": {
                            "title": "Autopay Status",
                            "type": "boolean",
                            "description": "Tracks the visitor's autopay enrollment status.",
                            "meta:titleId": "experienceevent-autopay-enrollment-details##xdm:autoPayEnrollmentStatus##title##71471",
                            "meta:descriptionId": "experienceevent-autopay-enrollment-details##xdm:autoPayEnrollmentStatus##description##48901"
                        }
                    }
                }
            }
        }
    },
    "allOf": [
        {
            "$ref": "#/definitions/autopay-enrollment-details"
        }
    ],
    "meta:status": "deprecated",
    "meta:createdDate": "2021-02-19",
    "meta:titleId": "experienceevent-autopay-enrollment-details##title##71701",
    "meta:descriptionId": "experienceevent-autopay-enrollment-details##description##84181",
    "examples": [
        {
            "xdm:autopayEnrollment": {
                "xdm:autoPayEnrollment": {
                    "xdm:tool-usage": {
                        "xdm:toolUsageCancelled": 1,
                        "xdm:toolUsageComplete": 1,
                        "xdm:toolUsageFailure": 1,
                        "xdm:toolUsageID": "T421",
                        "xdm:toolUsageName": "autopay enrollment",
                        "xdm:toolUsageSaved": 1,
                        "xdm:toolUsageStart": 1,
                        "xdm:toolUsageStep": 1,
                        "xdm:toolUsageStepName": "select account",
                        "xdm:toolUsageSubmitted": 1,
                        "xdm:toolUsageType": "self service"
                    }
                },
                "xdm:autoPayEnrollmentStatus": true
            }
        }
    ]
}