@compassdigital/sdk.typescript 3.60.0 → 3.62.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,256 +0,0 @@
1
- // /* eslint-disable */
2
- // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
3
-
4
- import { RequestQuery, BaseRequest } from "./util";
5
-
6
- export interface Success {
7
- success?: boolean;
8
- }
9
-
10
- export interface Error {
11
- message?: string;
12
- code?: number;
13
- data?: any;
14
- }
15
-
16
- export interface PermissionBody {
17
- recipient_id?: string;
18
- // The organization or domain to which this role belongs
19
- domain: string;
20
- // The object type we give permission to
21
- object: string;
22
- // The action we allow to happen.
23
- action: string;
24
- // The relationship link to the resource. If not passed *:RECIPIENT_USER_ID is used
25
- link?: string;
26
- // Properties that are allowed in permission. If not allowed should be prefixed with !.
27
- properties?: string;
28
- }
29
-
30
- export interface Permission {
31
- // permission
32
- id?: string;
33
- recipient_id?: string;
34
- // The organization or domain to which this role belongs
35
- domain: string;
36
- // The object type we give permission to
37
- object: string;
38
- // The action we allow to happen.
39
- action: string;
40
- // The relationship link to the resource
41
- link?: string;
42
- // Properties that are allowed in permission. If not allowed should be prefixed with !.
43
- properties?: string;
44
- last_updated_by?: string;
45
- date_created?: string;
46
- date_modified?: string;
47
- }
48
-
49
- export interface Permissions {
50
- permissions: Permission[];
51
- }
52
-
53
- export interface Role {
54
- // role
55
- id: string;
56
- // Role Name
57
- name: string;
58
- // The status of whether the role is in use or not
59
- status: string;
60
- // The organization or domain to which this role belongs
61
- domain: string;
62
- // The description of the role
63
- description?: string;
64
- last_updated_by?: string;
65
- date_created?: string;
66
- date_modified?: string;
67
- }
68
-
69
- export interface RoleBody {
70
- // Role Name
71
- name: string;
72
- // The status of whether the role is in use or not
73
- status?: string;
74
- // The organization or domain to which this role belongs
75
- domain: string;
76
- // The description of the role
77
- description?: string;
78
- }
79
-
80
- export interface RolePatchBody {
81
- // Role Name
82
- name?: string;
83
- // The status of whether the role is in use or not
84
- status?: string;
85
- // The description of the role
86
- description?: string;
87
- }
88
-
89
- export interface RoleAssignmentBody {
90
- // role
91
- role_id: string;
92
- recipient_id: string;
93
- meta?: {
94
- [index: string]: any;
95
- };
96
- }
97
-
98
- export interface RoleAssignment {
99
- // role_assignment
100
- id: string;
101
- // role
102
- role_id: string;
103
- recipient_id: string;
104
- meta?: {
105
- [index: string]: any;
106
- };
107
- last_updated_by?: string;
108
- date_created?: string;
109
- date_modified?: string;
110
- }
111
-
112
- export interface RoleAssignments {
113
- role_assignments: RoleAssignment[];
114
- }
115
-
116
- export interface Roles {
117
- roles: Role[];
118
- last_key?: string;
119
- }
120
-
121
- // POST /permission - Creates a new permission for a role or a user
122
-
123
- export type PostPermissionBody = PermissionBody;
124
-
125
- export type PostPermissionResponse = Permission;
126
-
127
- export interface PostPermissionRequest extends BaseRequest {
128
- body: PostPermissionBody;
129
- }
130
-
131
- // DELETE /permission/{id} - Delete a permission from a role or a user
132
-
133
- export interface DeletePermissionPath {
134
- // permission
135
- id: string;
136
- }
137
-
138
- export type DeletePermissionResponse = Success;
139
-
140
- export interface DeletePermissionRequest extends BaseRequest, DeletePermissionPath {}
141
-
142
- // GET /permission/role - Get Roles, with pagination and filters
143
-
144
- export interface GetPermissionRoleQuery {
145
- // Filter roles by their domain
146
- domain: string;
147
- // Filter roles by their status.
148
- status?: string;
149
- // Key for pagination, retrieves the next page of items
150
- start_at?: string;
151
- // Graphql query string
152
- _query?: string;
153
- }
154
-
155
- export type GetPermissionRoleResponse = Roles;
156
-
157
- export interface GetPermissionRoleRequest
158
- extends BaseRequest,
159
- RequestQuery<GetPermissionRoleQuery> {}
160
-
161
- // POST /permission/role - Create a new role
162
-
163
- export type PostPermissionRoleBody = RoleBody;
164
-
165
- export type PostPermissionRoleResponse = Role;
166
-
167
- export interface PostPermissionRoleRequest extends BaseRequest {
168
- body: PostPermissionRoleBody;
169
- }
170
-
171
- // PATCH /permission/role/{id} - Update a role
172
-
173
- export interface PatchPermissionRolePath {
174
- // role
175
- id: string;
176
- }
177
-
178
- export type PatchPermissionRoleBody = RolePatchBody;
179
-
180
- export type PatchPermissionRoleResponse = Role;
181
-
182
- export interface PatchPermissionRoleRequest extends BaseRequest, PatchPermissionRolePath {
183
- body: PatchPermissionRoleBody;
184
- }
185
-
186
- // GET /permission/recipient/{recipient_id} - Get permissions for a recipient(role or user id)
187
-
188
- export interface GetPermissionRecipientPath {
189
- // CDL Id of a recipient
190
- recipient: string;
191
- // TODO: add parameter to swagger.json
192
- recipient_id: string;
193
- }
194
-
195
- export interface GetPermissionRecipientQuery {
196
- // Show additional meta fields
197
- extended?: boolean;
198
- // Graphql query string
199
- _query?: string;
200
- }
201
-
202
- export type GetPermissionRecipientResponse = Permissions;
203
-
204
- export interface GetPermissionRecipientRequest
205
- extends BaseRequest,
206
- RequestQuery<GetPermissionRecipientQuery>,
207
- GetPermissionRecipientPath {}
208
-
209
- // GET /permission/role/user/{user_id} - Get a list of role assignments for a user
210
-
211
- export interface GetPermissionRoleUserPath {
212
- // Id of a user
213
- user_id: string;
214
- }
215
-
216
- export interface GetPermissionRoleUserQuery {
217
- // Graphql query string
218
- _query?: string;
219
- }
220
-
221
- export type GetPermissionRoleUserResponse = RoleAssignments;
222
-
223
- export interface GetPermissionRoleUserRequest
224
- extends BaseRequest,
225
- RequestQuery<GetPermissionRoleUserQuery>,
226
- GetPermissionRoleUserPath {}
227
-
228
- // POST /permission/role/user/{user_id} - Assign a role to a user
229
-
230
- export interface PostPermissionRoleUserPath {
231
- // Id of a user
232
- user_id: string;
233
- }
234
-
235
- export type PostPermissionRoleUserBody = RoleAssignmentBody;
236
-
237
- export type PostPermissionRoleUserResponse = RoleAssignment;
238
-
239
- export interface PostPermissionRoleUserRequest extends BaseRequest, PostPermissionRoleUserPath {
240
- body: PostPermissionRoleUserBody;
241
- }
242
-
243
- // DELETE /permission/role/user/{user_id} - Remove a role from a user
244
-
245
- export interface DeletePermissionRoleUserPath {
246
- // Id of a user
247
- user_id: string;
248
- }
249
-
250
- export type DeletePermissionRoleUserBody = RoleAssignment;
251
-
252
- export type DeletePermissionRoleUserResponse = Success;
253
-
254
- export interface DeletePermissionRoleUserRequest extends BaseRequest, DeletePermissionRoleUserPath {
255
- body: DeletePermissionRoleUserBody;
256
- }
@@ -1,4 +0,0 @@
1
- // /* eslint-disable */
2
- // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
3
-
4
- import { RequestQuery, BaseRequest } from "./util";