-
Notifications
You must be signed in to change notification settings - Fork 97
/
organization-membership.ts
117 lines (107 loc) · 3.39 KB
/
organization-membership.ts
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
import copy from 'fast-copy'
import { freezeSys, toPlainObject } from 'contentful-sdk-core'
import enhanceWithMethods from '../enhance-with-methods'
import { wrapCollection } from '../common-utils'
import { MetaSysProps, DefaultElements, MetaLinkProps, MakeRequest } from '../common-types'
export type OrganizationMembershipProps = {
/**
* System metadata
*/
sys: MetaSysProps & { user: { sys: MetaLinkProps } }
/**
* Role
*/
role: string
/**
* status
*/
status: boolean
}
export interface OrganizationMembership
extends OrganizationMembershipProps,
DefaultElements<OrganizationMembershipProps> {
/**
* Sends an update to the server with any changes made to the object's properties
* @return Object returned from the server with updated changes.
* @example ```javascript
* const contentful = require('contentful-management')
*
* const client = contentful.createClient({
* accessToken: '<content_management_api_key>'
* })
*
* client.getOrganization('organization_id')
* .then(org => org.getOrganizationMembership('organizationMembership_id'))
* .then((organizationMembership) => {
* organizationMembership.role = 'member';
* organizationMembership.update();
* })
* .catch(console.error)
*/
update(): Promise<OrganizationMembership>
/**
* Deletes this object on the server.
* @example```javascript
* const contentful = require('contentful-management')
*
* const client = contentful.createClient({
* accessToken: '<content_management_api_key>'
* })
*
* client.getOrganization('organization_id')
* .then(org => org.getOrganizationMembership('organizationMembership_id'))
* .then((organizationMembership) => {
* organizationMembership.delete();
* })
* .catch(console.error)
* ```
*/
delete(): Promise<void>
}
function createOrganizationMembershipApi(makeRequest: MakeRequest, organizationId: string) {
const getParams = (data: OrganizationMembershipProps) => ({
organizationMembershipId: data.sys.id,
organizationId,
})
return {
update: function () {
const raw = this.toPlainObject() as OrganizationMembershipProps
return makeRequest({
entityType: 'OrganizationMembership',
action: 'update',
params: getParams(raw),
payload: raw,
}).then((data) => wrapOrganizationMembership(makeRequest, data, organizationId))
},
delete: function del() {
const raw = this.toPlainObject() as OrganizationMembershipProps
return makeRequest({
entityType: 'OrganizationMembership',
action: 'delete',
params: getParams(raw),
})
},
}
}
/**
* @private
* @param {function} makeRequest - function to make requests via an adapter
* @param {Object} data - Raw organization membership data
* @return {OrganizationMembership} Wrapped organization membership data
*/
export function wrapOrganizationMembership(
makeRequest: MakeRequest,
data: OrganizationMembershipProps,
organizationId: string
): OrganizationMembership {
const organizationMembership = toPlainObject(copy(data))
const organizationMembershipWithMethods = enhanceWithMethods(
organizationMembership,
createOrganizationMembershipApi(makeRequest, organizationId)
)
return freezeSys(organizationMembershipWithMethods)
}
/**
* @private
*/
export const wrapOrganizationMembershipCollection = wrapCollection(wrapOrganizationMembership)