github.com/optim-corp/cios-golang-sdk@v0.5.1/openapi/components/group-component.openapi.yml (about) 1 openapi: 3.0.3 2 info: 3 title: Group Component 4 description: Component 5 version: 1.0.0 6 7 paths: {} 8 9 components: 10 schemas: 11 MultipleGroup: 12 type: object 13 required: 14 - groups 15 - total 16 properties: 17 total: 18 type: integer 19 format: int64 20 groups: 21 type: array 22 items: 23 $ref: '#/components/schemas/Group' 24 Group: 25 type: object 26 required: 27 - id 28 - name 29 - type 30 properties: 31 id: 32 type: string 33 format: uuid 34 parent_group_id: 35 type: string 36 format: uuid 37 corporation_id: 38 type: string 39 format: uuid 40 name: 41 type: string 42 type: 43 type: string 44 enum: 45 - Corporation 46 - Group 47 domain: 48 type: string 49 nullable: true 50 phone_number: 51 type: string 52 phone_number_2: 53 type: string 54 address: 55 type: object 56 properties: 57 country: 58 type: string 59 zip_code: 60 type: string 61 state: 62 type: string 63 city: 64 type: string 65 address_1: 66 type: string 67 address_2: 68 type: string 69 tags: 70 type: array 71 items: 72 type: string 73 custom_fields: 74 type: object 75 children: 76 type: array 77 items: 78 type: object 79 properties: 80 id: 81 type: string 82 format: uuid 83 name: 84 type: string 85 GroupUpdateRequest: 86 type: object 87 properties: 88 parent_group_id: 89 type: string 90 format: uuid 91 name: 92 type: string 93 type: 94 type: string 95 enum: 96 - Corporation 97 - Group 98 phone_number: 99 type: string 100 phone_number_2: 101 type: string 102 address: 103 type: object 104 properties: 105 country: 106 type: string 107 zip_code: 108 type: string 109 state: 110 type: string 111 city: 112 type: string 113 address_1: 114 type: string 115 address_2: 116 type: string 117 tags: 118 type: array 119 items: 120 type: string 121 custom_fields: 122 type: object 123 GroupCreateRequest: 124 type: object 125 properties: 126 parent_group_id: 127 type: string 128 format: uuid 129 name: 130 type: string 131 phone_number: 132 type: string 133 phone_number_2: 134 type: string 135 address: 136 type: object 137 properties: 138 country: 139 type: string 140 zip_code: 141 type: string 142 state: 143 type: string 144 city: 145 type: string 146 address_1: 147 type: string 148 address_2: 149 type: string 150 tags: 151 type: array 152 items: 153 type: string 154 type: 155 type: string 156 enum: 157 - Group 158 custom_fields: { } 159 required: 160 - name 161 - type 162 GroupInviteRequest: 163 type: object 164 properties: 165 email: 166 type: string 167 GroupReplaceRequest: 168 type: object 169 properties: 170 parent_group_id: 171 type: string 172 format: uuid 173 name: 174 type: string 175 type: 176 type: string 177 enum: 178 - Group 179 phone_number: 180 type: string 181 phone_number_2: 182 type: string 183 address: 184 type: object 185 properties: 186 country: 187 type: string 188 zip_code: 189 type: string 190 state: 191 type: string 192 city: 193 type: string 194 address_1: 195 type: string 196 address_2: 197 type: string 198 tags: 199 type: array 200 items: 201 type: string 202 MultipleMember: 203 type: object 204 properties: 205 total: 206 type: integer 207 format: int64 208 members: 209 type: array 210 items: 211 $ref: '#/components/schemas/Member' 212 MultipleMemberInfo: 213 type: object 214 properties: 215 total: 216 type: integer 217 minimum: 0 218 format: int64 219 members: 220 type: array 221 items: 222 $ref: '#/components/schemas/MemberInfo' 223 SingleMember: 224 type: object 225 properties: 226 member: 227 $ref: '#/components/schemas/Member' 228 Members: 229 type: array 230 items: 231 $ref: "#/components/schemas/Member" 232 Member: 233 type: object 234 properties: 235 id: 236 type: string 237 format: uuid 238 user_id: 239 type: string 240 format: uuid 241 role: 242 type: string 243 enum: 244 - super_admin 245 - admin 246 - manager 247 - staff 248 category: 249 type: string 250 invited: 251 type: boolean 252 tags: 253 type: array 254 items: 255 type: string 256 custom_fields: { } 257 MemberInfo: 258 type: object 259 properties: 260 id: 261 type: string 262 format: uuid 263 user_id: 264 type: string 265 format: uuid 266 role: 267 type: string 268 enum: 269 - super_admin 270 - admin 271 - manager 272 - staff 273 category: 274 type: string 275 enum: 276 - member 277 - guest 278 invited: 279 type: boolean 280 tags: 281 type: array 282 items: 283 type: string 284 profile: 285 type: object 286 properties: 287 type: 288 type: string 289 family_name: 290 type: string 291 given_name: 292 type: string 293 phonetic_family_name: 294 type: string 295 phonetic_given_name: 296 type: string 297 email: 298 type: string 299 300 emails: 301 type: array 302 items: 303 type: string 304 305 picture: 306 type: string 307 phone_number: 308 type: string 309 phone_number_2: 310 type: string 311 language: 312 type: string 313 enum: 314 - ja 315 - en 316 - en-US 317 - de-DE 318 - fe-FR 319 - es-ES 320 address: 321 type: object 322 properties: 323 country: 324 type: string 325 zip_code: 326 type: string 327 state: 328 type: string 329 city: 330 type: string 331 address_1: 332 type: string 333 address_2: 334 type: string