1
|
|
|
<?php |
2
|
|
|
/** |
3
|
|
|
* This file is part of the WrikePhpSdk package. |
4
|
|
|
* |
5
|
|
|
* (c) Zbigniew Ślązak |
6
|
|
|
* |
7
|
|
|
* For the full copyright and license information, please view the LICENSE |
8
|
|
|
* file that was distributed with this source code. |
9
|
|
|
*/ |
10
|
|
|
|
11
|
|
|
namespace Zibios\WrikePhpSdk\Documents\Group; |
12
|
|
|
|
13
|
|
|
use JMS\Serializer\Annotation as SA; |
14
|
|
|
use Zibios\WrikePhpSdk\Documents\Components\MetadataDocument; |
15
|
|
|
use Zibios\WrikePhpSdk\Documents\ResourceDocumentAbstract; |
16
|
|
|
|
17
|
|
|
/** |
18
|
|
|
* Group Resource Document |
19
|
|
|
*/ |
20
|
|
|
class GroupResourceDocument extends ResourceDocumentAbstract |
21
|
|
|
{ |
22
|
|
|
/** |
23
|
|
|
* Contact ID |
24
|
|
|
* |
25
|
|
|
* Comment: Contact ID |
26
|
|
|
* |
27
|
|
|
* @SA\Type("string") |
28
|
|
|
* @SA\SerializedName("id") |
29
|
|
|
* @var string|null |
30
|
|
|
*/ |
31
|
|
|
protected $id; |
32
|
|
|
|
33
|
|
|
/** |
34
|
|
|
* Account ID |
35
|
|
|
* |
36
|
|
|
* Comment: Account ID |
37
|
|
|
* |
38
|
|
|
* @SA\Type("string") |
39
|
|
|
* @SA\SerializedName("accountId") |
40
|
|
|
* @var string|null |
41
|
|
|
*/ |
42
|
|
|
protected $accountId; |
43
|
|
|
|
44
|
|
|
/** |
45
|
|
|
* Group Title |
46
|
|
|
* |
47
|
|
|
* @SA\Type("string") |
48
|
|
|
* @SA\SerializedName("title") |
49
|
|
|
* @var string|null |
50
|
|
|
*/ |
51
|
|
|
protected $title; |
52
|
|
|
|
53
|
|
|
/** |
54
|
|
|
* List of group members user IDs |
55
|
|
|
* |
56
|
|
|
* Comment: Contact ID list |
57
|
|
|
* |
58
|
|
|
* @SA\Type("array<string>") |
59
|
|
|
* @SA\SerializedName("memberIds") |
60
|
|
|
* @var array|string[]|null |
61
|
|
|
*/ |
62
|
|
|
protected $memberIds; |
63
|
|
|
|
64
|
|
|
/** |
65
|
|
|
* List of child group IDs |
66
|
|
|
* |
67
|
|
|
* Comment: Contact ID list |
68
|
|
|
* |
69
|
|
|
* @SA\Type("array<string>") |
70
|
|
|
* @SA\SerializedName("childIds") |
71
|
|
|
* @var array|string[]|null |
72
|
|
|
*/ |
73
|
|
|
protected $childIds; |
74
|
|
|
|
75
|
|
|
/** |
76
|
|
|
* List of parent group IDs |
77
|
|
|
* |
78
|
|
|
* Comment: Contact ID list |
79
|
|
|
* |
80
|
|
|
* @SA\Type("array<string>") |
81
|
|
|
* @SA\SerializedName("parentIds") |
82
|
|
|
* @var array|string[]|null |
83
|
|
|
*/ |
84
|
|
|
protected $parentIds; |
85
|
|
|
|
86
|
|
|
/** |
87
|
|
|
* Avatar URL |
88
|
|
|
* |
89
|
|
|
* @SA\Type("string") |
90
|
|
|
* @SA\SerializedName("avatarUrl") |
91
|
|
|
* @var string|null |
92
|
|
|
*/ |
93
|
|
|
protected $avatarUrl; |
94
|
|
|
|
95
|
|
|
/** |
96
|
|
|
* Field is present and set to true for My Team (default) group |
97
|
|
|
* Optional |
98
|
|
|
* |
99
|
|
|
* Comment: Optional |
100
|
|
|
* |
101
|
|
|
* @SA\Type("boolean") |
102
|
|
|
* @SA\SerializedName("myTeam") |
103
|
|
|
* @var bool|null |
104
|
|
|
*/ |
105
|
|
|
protected $myTeam; |
106
|
|
|
|
107
|
|
|
/** |
108
|
|
|
* List of group metadata entries |
109
|
|
|
* Metadata entry key-value pair |
110
|
|
|
* Metadata entries are isolated on per-client (application) basis |
111
|
|
|
* Optional |
112
|
|
|
* |
113
|
|
|
* Comment: Optional |
114
|
|
|
* |
115
|
|
|
* @SA\Type("array<Zibios\WrikePhpSdk\Api\Documents\Components\MetadataDocument>") |
116
|
|
|
* @SA\SerializedName("metadata") |
117
|
|
|
* @var array|MetadataDocument[]|null |
118
|
|
|
*/ |
119
|
|
|
protected $metadata; |
120
|
|
|
|
121
|
|
|
/** |
122
|
|
|
* @return null|string |
123
|
|
|
*/ |
124
|
5 |
|
public function getId() |
125
|
|
|
{ |
126
|
5 |
|
return $this->id; |
127
|
|
|
} |
128
|
|
|
|
129
|
|
|
/** |
130
|
|
|
* @param null|string $id |
131
|
|
|
* |
132
|
|
|
* @return $this |
133
|
|
|
*/ |
134
|
|
|
public function setId($id) |
135
|
|
|
{ |
136
|
|
|
$this->id = $id; |
137
|
|
|
|
138
|
|
|
return $this; |
139
|
|
|
} |
140
|
|
|
|
141
|
|
|
/** |
142
|
|
|
* @return null|string |
143
|
|
|
*/ |
144
|
|
|
public function getAccountId() |
145
|
|
|
{ |
146
|
|
|
return $this->accountId; |
147
|
|
|
} |
148
|
|
|
|
149
|
|
|
/** |
150
|
|
|
* @param null|string $accountId |
151
|
|
|
* |
152
|
|
|
* @return $this |
153
|
|
|
*/ |
154
|
|
|
public function setAccountId($accountId) |
155
|
|
|
{ |
156
|
|
|
$this->accountId = $accountId; |
157
|
|
|
|
158
|
|
|
return $this; |
159
|
|
|
} |
160
|
|
|
|
161
|
|
|
/** |
162
|
|
|
* @return null|string |
163
|
|
|
*/ |
164
|
|
|
public function getTitle() |
165
|
|
|
{ |
166
|
|
|
return $this->title; |
167
|
|
|
} |
168
|
|
|
|
169
|
|
|
/** |
170
|
|
|
* @param null|string $title |
171
|
|
|
* |
172
|
|
|
* @return $this |
173
|
|
|
*/ |
174
|
|
|
public function setTitle($title) |
175
|
|
|
{ |
176
|
|
|
$this->title = $title; |
177
|
|
|
|
178
|
|
|
return $this; |
179
|
|
|
} |
180
|
|
|
|
181
|
|
|
/** |
182
|
|
|
* @return array|null|\string[] |
183
|
|
|
*/ |
184
|
|
|
public function getMemberIds() |
185
|
|
|
{ |
186
|
|
|
return $this->memberIds; |
187
|
|
|
} |
188
|
|
|
|
189
|
|
|
/** |
190
|
|
|
* @param array|null|\string[] $memberIds |
191
|
|
|
* |
192
|
|
|
* @return $this |
193
|
|
|
*/ |
194
|
|
|
public function setMemberIds($memberIds) |
195
|
|
|
{ |
196
|
|
|
$this->memberIds = $memberIds; |
197
|
|
|
|
198
|
|
|
return $this; |
199
|
|
|
} |
200
|
|
|
|
201
|
|
|
/** |
202
|
|
|
* @return array|null|\string[] |
203
|
|
|
*/ |
204
|
|
|
public function getChildIds() |
205
|
|
|
{ |
206
|
|
|
return $this->childIds; |
207
|
|
|
} |
208
|
|
|
|
209
|
|
|
/** |
210
|
|
|
* @param array|null|\string[] $childIds |
211
|
|
|
* |
212
|
|
|
* @return $this |
213
|
|
|
*/ |
214
|
|
|
public function setChildIds($childIds) |
215
|
|
|
{ |
216
|
|
|
$this->childIds = $childIds; |
217
|
|
|
|
218
|
|
|
return $this; |
219
|
|
|
} |
220
|
|
|
|
221
|
|
|
/** |
222
|
|
|
* @return array|null|\string[] |
223
|
|
|
*/ |
224
|
|
|
public function getParentIds() |
225
|
|
|
{ |
226
|
|
|
return $this->parentIds; |
227
|
|
|
} |
228
|
|
|
|
229
|
|
|
/** |
230
|
|
|
* @param array|null|\string[] $parentIds |
231
|
|
|
* |
232
|
|
|
* @return $this |
233
|
|
|
*/ |
234
|
|
|
public function setParentIds($parentIds) |
235
|
|
|
{ |
236
|
|
|
$this->parentIds = $parentIds; |
237
|
|
|
|
238
|
|
|
return $this; |
239
|
|
|
} |
240
|
|
|
|
241
|
|
|
/** |
242
|
|
|
* @return null|string |
243
|
|
|
*/ |
244
|
|
|
public function getAvatarUrl() |
245
|
|
|
{ |
246
|
|
|
return $this->avatarUrl; |
247
|
|
|
} |
248
|
|
|
|
249
|
|
|
/** |
250
|
|
|
* @param null|string $avatarUrl |
251
|
|
|
* |
252
|
|
|
* @return $this |
253
|
|
|
*/ |
254
|
|
|
public function setAvatarUrl($avatarUrl) |
255
|
|
|
{ |
256
|
|
|
$this->avatarUrl = $avatarUrl; |
257
|
|
|
|
258
|
|
|
return $this; |
259
|
|
|
} |
260
|
|
|
|
261
|
|
|
/** |
262
|
|
|
* @return bool|null |
263
|
|
|
*/ |
264
|
|
|
public function getMyTeam() |
265
|
|
|
{ |
266
|
|
|
return $this->myTeam; |
267
|
|
|
} |
268
|
|
|
|
269
|
|
|
/** |
270
|
|
|
* @param bool|null $myTeam |
271
|
|
|
* |
272
|
|
|
* @return $this |
273
|
|
|
*/ |
274
|
|
|
public function setMyTeam($myTeam) |
275
|
|
|
{ |
276
|
|
|
$this->myTeam = $myTeam; |
277
|
|
|
|
278
|
|
|
return $this; |
279
|
|
|
} |
280
|
|
|
|
281
|
|
|
/** |
282
|
|
|
* @return array|null|MetadataDocument[] |
283
|
|
|
*/ |
284
|
|
|
public function getMetadata() |
285
|
|
|
{ |
286
|
|
|
return $this->metadata; |
287
|
|
|
} |
288
|
|
|
|
289
|
|
|
/** |
290
|
|
|
* @param array|null|MetadataDocument[] $metadata |
291
|
|
|
* |
292
|
|
|
* @return $this |
293
|
|
|
*/ |
294
|
|
|
public function setMetadata($metadata) |
295
|
|
|
{ |
296
|
|
|
$this->metadata = $metadata; |
297
|
|
|
|
298
|
|
|
return $this; |
299
|
|
|
} |
300
|
|
|
} |
301
|
|
|
|