platform-client/consent.js at develop · tidepool-org/platform-client · 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
'use strict';

var _ = require('lodash');

module.exports = function (common) {
  return {
    /**
     * Returns the latest consent version for the given type
     *
     * @param {String} consentType - type of the consent (e.g., 'big_data_donation_project')
     * @param cb
     * @returns {cb} cb(err, response)
     */
    getLatestConsentByType: function (consentType, cb) {
      common.assertArgumentsSize(arguments, 2);
      common.doGetWithToken(
        `/v1/consents/${consentType}`,
        { 200: function(res){ return res.body; }, 404: [] },
        cb
      );
    },

    /**
     * Returns a list of all user consent records.
     * By default only the most recent consent record for a given consent type will be returned.
     * Note: Returning all historical versions (with `version=all`) is not currently supported by this client method.
     *
     * @param {String} userId - id of the user to fetch consents for
     * @param {String} consentType - type of the consent (e.g., 'big_data_donation_project')
     * @param cb
     * @returns {cb} cb(err, response)
     */
    getUserConsentRecords: function (userId, consentType, cb) {
      common.assertArgumentsSize(arguments, 3);
      common.doGetWithToken(
        `/v1/users/${userId}/consents?type=${consentType}`,
        { 200: function(res){ return res.body; }, 404: [] },
        cb
      );
    },

    /**
     * Creates a user consent record
     *
     * @param {String} userId - id of the user to fetch consents for
     * @param {Object} consentRecord - the consent record to create
     * @param {String} consentRecord.ageGroup - Allowed values: ['<13', '13-17', '>=18']
     * @param {String} consentRecord.ownerName - The name of the account owner
     * @param {String} [consentRecord.parentGuardianName] - The name of the parent or legal guardian granting the consent record. Required if ageGroup is '<13' or '13-17'.
     * @param {String} consentRecord.grantorType - Allowed values: ['owner', 'parent/guardian']
     * @param {String} consentRecord.type - type of the consentRecord (e.g., 'big_data_donation_project')
     * @param {Object} [consentRecord.metadata]
     * @param {String[]} [consentRecord.metadata.supportedOrganizations] - Allowed values: ['ADCES Foundation', 'Beyond Type 1', 'Children With Diabetes', 'The Diabetes Link', 'Diabetes Youth Families (DYF)', 'DiabetesSisters', 'The diaTribe Foundation', 'Breakthrough T1D']
     * @param {Number} consentRecord.version - >=1
     * @param cb
     * @returns {cb} cb(err, response)
     */
    createUserConsentRecord: function (userId, consentRecord, cb) {
      common.assertArgumentsSize(arguments, 3);
      common.doPostWithToken(
        `/v1/users/${userId}/consents`,
        consentRecord,
        { 200: function(res){ return res.body; } },
        cb
      );
    },

    /**
     * Updates a user consent record
     *
     * @param {String} userId - id of the user to update a consent for
     * @param {String} recordId - id of the consent record to update
     * @param {Object} updates
     * @param {Object} updates.metadata
     * @param {Array[String]} [updates.metadata.supportedOrganizations] - Allowed values: ['ADCES Foundation', 'Beyond Type 1', 'Children With Diabetes', 'The Diabetes Link', 'Diabetes Youth Families (DYF)', 'DiabetesSisters', 'The diaTribe Foundation', 'Breakthrough T1D']
     * @param cb
     * @returns {cb} cb(err, response)
     */
    updateUserConsentRecord: function (userId, recordId, updates, cb) {
      common.assertArgumentsSize(arguments, 4);
      common.doPatchWithToken(
        `/v1/users/${userId}/consents/${recordId}`,
        updates,
        { 200: function(res){ return res.body; } },
        cb
      );
    },

    /**
     * Revokes a user consent record
     *
     * @param {String} userId - id of the user to revoke a consent for
     * @param {String} recordId - id of the consent record to revoke
     * @param cb
     * @returns {cb} cb(err, response)
     */
    revokeUserConsentRecord: function (userId, recordId, cb) {
      common.assertArgumentsSize(arguments, 3);
      common.doDeleteWithToken(
        `/v1/users/${userId}/consents/${recordId}`,
        { 204: function(){ return null; } },
        cb
      );
    },
  };
};