@seamapi/types 1.7.1 → 1.8.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.
@@ -448,6 +448,18 @@ export interface Routes {
448
448
  };
449
449
  };
450
450
  };
451
+ '/acs/access_groups/add_user': {
452
+ route: '/acs/access_groups/add_user';
453
+ method: 'PATCH' | 'POST';
454
+ queryParams: {};
455
+ jsonBody: {};
456
+ commonParams: {
457
+ acs_access_group_id: string;
458
+ acs_user_id: string;
459
+ };
460
+ formData: {};
461
+ jsonResponse: {};
462
+ };
451
463
  '/acs/access_groups/create': {
452
464
  route: '/acs/access_groups/create';
453
465
  method: 'POST';
@@ -524,6 +536,40 @@ export interface Routes {
524
536
  }>;
525
537
  };
526
538
  };
539
+ '/acs/access_groups/list_users': {
540
+ route: '/acs/access_groups/list_users';
541
+ method: 'GET' | 'POST';
542
+ queryParams: {};
543
+ jsonBody: {};
544
+ commonParams: {
545
+ acs_access_group_id: string;
546
+ };
547
+ formData: {};
548
+ jsonResponse: {
549
+ acs_users: Array<{
550
+ acs_user_id: string;
551
+ acs_system_id: string;
552
+ workspace_id: string;
553
+ created_at: string;
554
+ display_name: string;
555
+ full_name?: string | undefined;
556
+ email?: string | undefined;
557
+ phone_number?: string | undefined;
558
+ }>;
559
+ };
560
+ };
561
+ '/acs/access_groups/remove_user': {
562
+ route: '/acs/access_groups/remove_user';
563
+ method: 'DELETE' | 'POST';
564
+ queryParams: {};
565
+ jsonBody: {};
566
+ commonParams: {
567
+ acs_access_group_id: string;
568
+ acs_user_id: string;
569
+ };
570
+ formData: {};
571
+ jsonResponse: {};
572
+ };
527
573
  '/acs/access_groups/update': {
528
574
  route: '/acs/access_groups/update';
529
575
  method: 'POST' | 'PATCH';
@@ -3,8 +3,8 @@ export declare const acs_user: z.ZodObject<{
3
3
  workspace_id: z.ZodString;
4
4
  created_at: z.ZodString;
5
5
  display_name: z.ZodString;
6
- acs_system_id: z.ZodString;
7
6
  acs_user_id: z.ZodString;
7
+ acs_system_id: z.ZodString;
8
8
  full_name: z.ZodOptional<z.ZodString>;
9
9
  email: z.ZodOptional<z.ZodString>;
10
10
  phone_number: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
@@ -12,8 +12,8 @@ export declare const acs_user: z.ZodObject<{
12
12
  workspace_id: string;
13
13
  created_at: string;
14
14
  display_name: string;
15
- acs_system_id: string;
16
15
  acs_user_id: string;
16
+ acs_system_id: string;
17
17
  full_name?: string | undefined;
18
18
  email?: string | undefined;
19
19
  phone_number?: string | undefined;
@@ -21,8 +21,8 @@ export declare const acs_user: z.ZodObject<{
21
21
  workspace_id: string;
22
22
  created_at: string;
23
23
  display_name: string;
24
- acs_system_id: string;
25
24
  acs_user_id: string;
25
+ acs_system_id: string;
26
26
  full_name?: string | undefined;
27
27
  email?: string | undefined;
28
28
  phone_number?: string | undefined;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.7.1",
3
+ "version": "1.8.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -3931,6 +3931,91 @@ export default {
3931
3931
  operationId: 'accessCodesUnmanagedUpdatePost',
3932
3932
  },
3933
3933
  },
3934
+ '/acs/access_groups/add_user': {
3935
+ post: {
3936
+ 'x-fern-sdk-group-name': ['acs', 'access_groups'],
3937
+ 'x-fern-sdk-method-name': 'add_user',
3938
+ summary: '/acs/access_groups/add_user',
3939
+ responses: {
3940
+ 200: {
3941
+ description: 'OK',
3942
+ content: {
3943
+ 'application/json': {
3944
+ schema: {
3945
+ type: 'object',
3946
+ properties: { ok: { type: 'boolean' } },
3947
+ required: ['ok'],
3948
+ },
3949
+ },
3950
+ },
3951
+ },
3952
+ 400: { description: 'Bad Request' },
3953
+ 401: { description: 'Unauthorized' },
3954
+ },
3955
+ security: [
3956
+ { seam_workspace: [], access_token: [] },
3957
+ { seam_client_session_token: [] },
3958
+ { client_session_token: [] },
3959
+ ],
3960
+ requestBody: {
3961
+ content: {
3962
+ 'application/json': {
3963
+ schema: {
3964
+ type: 'object',
3965
+ properties: {
3966
+ acs_access_group_id: { type: 'string', format: 'uuid' },
3967
+ acs_user_id: { type: 'string', format: 'uuid' },
3968
+ },
3969
+ required: ['acs_access_group_id', 'acs_user_id'],
3970
+ },
3971
+ },
3972
+ },
3973
+ },
3974
+ tags: [],
3975
+ operationId: 'acsAccessGroupsAddUserPost',
3976
+ },
3977
+ patch: {
3978
+ 'x-fern-ignore': true,
3979
+ summary: '/acs/access_groups/add_user',
3980
+ responses: {
3981
+ 200: {
3982
+ description: 'OK',
3983
+ content: {
3984
+ 'application/json': {
3985
+ schema: {
3986
+ type: 'object',
3987
+ properties: { ok: { type: 'boolean' } },
3988
+ required: ['ok'],
3989
+ },
3990
+ },
3991
+ },
3992
+ },
3993
+ 400: { description: 'Bad Request' },
3994
+ 401: { description: 'Unauthorized' },
3995
+ },
3996
+ security: [
3997
+ { seam_workspace: [], access_token: [] },
3998
+ { seam_client_session_token: [] },
3999
+ { client_session_token: [] },
4000
+ ],
4001
+ requestBody: {
4002
+ content: {
4003
+ 'application/json': {
4004
+ schema: {
4005
+ type: 'object',
4006
+ properties: {
4007
+ acs_access_group_id: { type: 'string', format: 'uuid' },
4008
+ acs_user_id: { type: 'string', format: 'uuid' },
4009
+ },
4010
+ required: ['acs_access_group_id', 'acs_user_id'],
4011
+ },
4012
+ },
4013
+ },
4014
+ },
4015
+ tags: [],
4016
+ operationId: 'acsAccessGroupsAddUserPatch',
4017
+ },
4018
+ },
3934
4019
  '/acs/access_groups/create': {
3935
4020
  post: {
3936
4021
  'x-fern-sdk-group-name': ['acs', 'access_groups'],
@@ -3945,31 +4030,7 @@ export default {
3945
4030
  type: 'object',
3946
4031
  properties: {
3947
4032
  acs_access_group: {
3948
- type: 'object',
3949
- properties: {
3950
- acs_access_group_id: { type: 'string', format: 'uuid' },
3951
- acs_system_id: { type: 'string', format: 'uuid' },
3952
- workspace_id: { type: 'string', format: 'uuid' },
3953
- name: { type: 'string' },
3954
- access_group_type: {
3955
- type: 'string',
3956
- enum: ['pti_unit'],
3957
- },
3958
- created_at: {
3959
- oneOf: [
3960
- { type: 'string' },
3961
- { type: 'string', format: 'date-time' },
3962
- ],
3963
- },
3964
- },
3965
- required: [
3966
- 'acs_access_group_id',
3967
- 'acs_system_id',
3968
- 'workspace_id',
3969
- 'name',
3970
- 'access_group_type',
3971
- 'created_at',
3972
- ],
4033
+ $ref: '#/components/schemas/acs_access_group',
3973
4034
  },
3974
4035
  ok: { type: 'boolean' },
3975
4036
  },
@@ -4061,31 +4122,7 @@ export default {
4061
4122
  type: 'object',
4062
4123
  properties: {
4063
4124
  acs_access_group: {
4064
- type: 'object',
4065
- properties: {
4066
- acs_access_group_id: { type: 'string', format: 'uuid' },
4067
- acs_system_id: { type: 'string', format: 'uuid' },
4068
- workspace_id: { type: 'string', format: 'uuid' },
4069
- name: { type: 'string' },
4070
- access_group_type: {
4071
- type: 'string',
4072
- enum: ['pti_unit'],
4073
- },
4074
- created_at: {
4075
- oneOf: [
4076
- { type: 'string' },
4077
- { type: 'string', format: 'date-time' },
4078
- ],
4079
- },
4080
- },
4081
- required: [
4082
- 'acs_access_group_id',
4083
- 'acs_system_id',
4084
- 'workspace_id',
4085
- 'name',
4086
- 'access_group_type',
4087
- 'created_at',
4088
- ],
4125
+ $ref: '#/components/schemas/acs_access_group',
4089
4126
  },
4090
4127
  ok: { type: 'boolean' },
4091
4128
  },
@@ -4134,36 +4171,7 @@ export default {
4134
4171
  properties: {
4135
4172
  acs_access_groups: {
4136
4173
  type: 'array',
4137
- items: {
4138
- type: 'object',
4139
- properties: {
4140
- acs_access_group_id: {
4141
- type: 'string',
4142
- format: 'uuid',
4143
- },
4144
- acs_system_id: { type: 'string', format: 'uuid' },
4145
- workspace_id: { type: 'string', format: 'uuid' },
4146
- name: { type: 'string' },
4147
- access_group_type: {
4148
- type: 'string',
4149
- enum: ['pti_unit'],
4150
- },
4151
- created_at: {
4152
- oneOf: [
4153
- { type: 'string' },
4154
- { type: 'string', format: 'date-time' },
4155
- ],
4156
- },
4157
- },
4158
- required: [
4159
- 'acs_access_group_id',
4160
- 'acs_system_id',
4161
- 'workspace_id',
4162
- 'name',
4163
- 'access_group_type',
4164
- 'created_at',
4165
- ],
4166
- },
4174
+ items: { $ref: '#/components/schemas/acs_access_group' },
4167
4175
  },
4168
4176
  ok: { type: 'boolean' },
4169
4177
  },
@@ -4197,6 +4205,99 @@ export default {
4197
4205
  operationId: 'acsAccessGroupsListPost',
4198
4206
  },
4199
4207
  },
4208
+ '/acs/access_groups/list_users': {
4209
+ post: {
4210
+ 'x-fern-sdk-group-name': ['acs', 'access_groups'],
4211
+ 'x-fern-sdk-method-name': 'list_users',
4212
+ summary: '/acs/access_groups/list_users',
4213
+ responses: {
4214
+ 200: {
4215
+ description: 'OK',
4216
+ content: {
4217
+ 'application/json': {
4218
+ schema: {
4219
+ type: 'object',
4220
+ properties: {
4221
+ acs_users: {
4222
+ type: 'array',
4223
+ items: { $ref: '#/components/schemas/acs_user' },
4224
+ },
4225
+ ok: { type: 'boolean' },
4226
+ },
4227
+ required: ['acs_users', 'ok'],
4228
+ },
4229
+ },
4230
+ },
4231
+ },
4232
+ 400: { description: 'Bad Request' },
4233
+ 401: { description: 'Unauthorized' },
4234
+ },
4235
+ security: [
4236
+ { seam_workspace: [], access_token: [] },
4237
+ { seam_client_session_token: [] },
4238
+ { client_session_token: [] },
4239
+ ],
4240
+ requestBody: {
4241
+ content: {
4242
+ 'application/json': {
4243
+ schema: {
4244
+ type: 'object',
4245
+ properties: {
4246
+ acs_access_group_id: { type: 'string', format: 'uuid' },
4247
+ },
4248
+ required: ['acs_access_group_id'],
4249
+ },
4250
+ },
4251
+ },
4252
+ },
4253
+ tags: [],
4254
+ operationId: 'acsAccessGroupsListUsersPost',
4255
+ },
4256
+ },
4257
+ '/acs/access_groups/remove_user': {
4258
+ post: {
4259
+ 'x-fern-sdk-group-name': ['acs', 'access_groups'],
4260
+ 'x-fern-sdk-method-name': 'remove_user',
4261
+ summary: '/acs/access_groups/remove_user',
4262
+ responses: {
4263
+ 200: {
4264
+ description: 'OK',
4265
+ content: {
4266
+ 'application/json': {
4267
+ schema: {
4268
+ type: 'object',
4269
+ properties: { ok: { type: 'boolean' } },
4270
+ required: ['ok'],
4271
+ },
4272
+ },
4273
+ },
4274
+ },
4275
+ 400: { description: 'Bad Request' },
4276
+ 401: { description: 'Unauthorized' },
4277
+ },
4278
+ security: [
4279
+ { seam_workspace: [], access_token: [] },
4280
+ { seam_client_session_token: [] },
4281
+ { client_session_token: [] },
4282
+ ],
4283
+ requestBody: {
4284
+ content: {
4285
+ 'application/json': {
4286
+ schema: {
4287
+ type: 'object',
4288
+ properties: {
4289
+ acs_access_group_id: { type: 'string', format: 'uuid' },
4290
+ acs_user_id: { type: 'string', format: 'uuid' },
4291
+ },
4292
+ required: ['acs_access_group_id', 'acs_user_id'],
4293
+ },
4294
+ },
4295
+ },
4296
+ },
4297
+ tags: [],
4298
+ operationId: 'acsAccessGroupsRemoveUserPost',
4299
+ },
4300
+ },
4200
4301
  '/acs/access_groups/update': {
4201
4302
  patch: {
4202
4303
  'x-fern-ignore': true,
@@ -4295,29 +4396,7 @@ export default {
4295
4396
  schema: {
4296
4397
  type: 'object',
4297
4398
  properties: {
4298
- acs_system: {
4299
- type: 'object',
4300
- properties: {
4301
- acs_system_id: { type: 'string', format: 'uuid' },
4302
- system_type: {
4303
- type: 'string',
4304
- enum: ['pti_site', 'alta_org'],
4305
- },
4306
- name: { type: 'string' },
4307
- created_at: {
4308
- oneOf: [
4309
- { type: 'string' },
4310
- { type: 'string', format: 'date-time' },
4311
- ],
4312
- },
4313
- },
4314
- required: [
4315
- 'acs_system_id',
4316
- 'system_type',
4317
- 'name',
4318
- 'created_at',
4319
- ],
4320
- },
4399
+ acs_system: { $ref: '#/components/schemas/acs_system' },
4321
4400
  ok: { type: 'boolean' },
4322
4401
  },
4323
4402
  required: ['acs_system', 'ok'],
@@ -4365,29 +4444,7 @@ export default {
4365
4444
  properties: {
4366
4445
  acs_systems: {
4367
4446
  type: 'array',
4368
- items: {
4369
- type: 'object',
4370
- properties: {
4371
- acs_system_id: { type: 'string', format: 'uuid' },
4372
- system_type: {
4373
- type: 'string',
4374
- enum: ['pti_site', 'alta_org'],
4375
- },
4376
- name: { type: 'string' },
4377
- created_at: {
4378
- oneOf: [
4379
- { type: 'string' },
4380
- { type: 'string', format: 'date-time' },
4381
- ],
4382
- },
4383
- },
4384
- required: [
4385
- 'acs_system_id',
4386
- 'system_type',
4387
- 'name',
4388
- 'created_at',
4389
- ],
4390
- },
4447
+ items: { $ref: '#/components/schemas/acs_system' },
4391
4448
  },
4392
4449
  ok: { type: 'boolean' },
4393
4450
  },
@@ -4420,29 +4477,7 @@ export default {
4420
4477
  properties: {
4421
4478
  acs_systems: {
4422
4479
  type: 'array',
4423
- items: {
4424
- type: 'object',
4425
- properties: {
4426
- acs_system_id: { type: 'string', format: 'uuid' },
4427
- system_type: {
4428
- type: 'string',
4429
- enum: ['pti_site', 'alta_org'],
4430
- },
4431
- name: { type: 'string' },
4432
- created_at: {
4433
- oneOf: [
4434
- { type: 'string' },
4435
- { type: 'string', format: 'date-time' },
4436
- ],
4437
- },
4438
- },
4439
- required: [
4440
- 'acs_system_id',
4441
- 'system_type',
4442
- 'name',
4443
- 'created_at',
4444
- ],
4445
- },
4480
+ items: { $ref: '#/components/schemas/acs_system' },
4446
4481
  },
4447
4482
  ok: { type: 'boolean' },
4448
4483
  },
@@ -4539,26 +4574,7 @@ export default {
4539
4574
  schema: {
4540
4575
  type: 'object',
4541
4576
  properties: {
4542
- acs_user: {
4543
- type: 'object',
4544
- properties: {
4545
- acs_user_id: { type: 'string', format: 'uuid' },
4546
- acs_system_id: { type: 'string', format: 'uuid' },
4547
- workspace_id: { type: 'string', format: 'uuid' },
4548
- created_at: { type: 'string', format: 'date-time' },
4549
- display_name: { type: 'string' },
4550
- full_name: { type: 'string' },
4551
- email: { type: 'string', format: 'email' },
4552
- phone_number: { type: 'string', nullable: true },
4553
- },
4554
- required: [
4555
- 'acs_user_id',
4556
- 'acs_system_id',
4557
- 'workspace_id',
4558
- 'created_at',
4559
- 'display_name',
4560
- ],
4561
- },
4577
+ acs_user: { $ref: '#/components/schemas/acs_user' },
4562
4578
  ok: { type: 'boolean' },
4563
4579
  },
4564
4580
  required: ['acs_user', 'ok'],
@@ -4580,10 +4596,17 @@ export default {
4580
4596
  schema: {
4581
4597
  type: 'object',
4582
4598
  properties: {
4599
+ acs_system_id: { type: 'string', format: 'uuid' },
4600
+ acs_access_group_ids: {
4601
+ default: [],
4602
+ type: 'array',
4603
+ items: { type: 'string', format: 'uuid' },
4604
+ },
4583
4605
  full_name: { type: 'string' },
4584
4606
  email: { type: 'string', format: 'email' },
4585
4607
  phone_number: { type: 'string', nullable: true },
4586
4608
  },
4609
+ required: ['acs_system_id'],
4587
4610
  },
4588
4611
  },
4589
4612
  },
@@ -4646,26 +4669,7 @@ export default {
4646
4669
  schema: {
4647
4670
  type: 'object',
4648
4671
  properties: {
4649
- acs_user: {
4650
- type: 'object',
4651
- properties: {
4652
- acs_user_id: { type: 'string', format: 'uuid' },
4653
- acs_system_id: { type: 'string', format: 'uuid' },
4654
- workspace_id: { type: 'string', format: 'uuid' },
4655
- created_at: { type: 'string', format: 'date-time' },
4656
- display_name: { type: 'string' },
4657
- full_name: { type: 'string' },
4658
- email: { type: 'string', format: 'email' },
4659
- phone_number: { type: 'string', nullable: true },
4660
- },
4661
- required: [
4662
- 'acs_user_id',
4663
- 'acs_system_id',
4664
- 'workspace_id',
4665
- 'created_at',
4666
- 'display_name',
4667
- ],
4668
- },
4672
+ acs_user: { $ref: '#/components/schemas/acs_user' },
4669
4673
  ok: { type: 'boolean' },
4670
4674
  },
4671
4675
  required: ['acs_user', 'ok'],
@@ -4711,26 +4715,7 @@ export default {
4711
4715
  properties: {
4712
4716
  acs_users: {
4713
4717
  type: 'array',
4714
- items: {
4715
- type: 'object',
4716
- properties: {
4717
- acs_user_id: { type: 'string', format: 'uuid' },
4718
- acs_system_id: { type: 'string', format: 'uuid' },
4719
- workspace_id: { type: 'string', format: 'uuid' },
4720
- created_at: { type: 'string', format: 'date-time' },
4721
- display_name: { type: 'string' },
4722
- full_name: { type: 'string' },
4723
- email: { type: 'string', format: 'email' },
4724
- phone_number: { type: 'string', nullable: true },
4725
- },
4726
- required: [
4727
- 'acs_user_id',
4728
- 'acs_system_id',
4729
- 'workspace_id',
4730
- 'created_at',
4731
- 'display_name',
4732
- ],
4733
- },
4718
+ items: { $ref: '#/components/schemas/acs_user' },
4734
4719
  },
4735
4720
  ok: { type: 'boolean' },
4736
4721
  },
@@ -4858,10 +4843,12 @@ export default {
4858
4843
  schema: {
4859
4844
  type: 'object',
4860
4845
  properties: {
4846
+ acs_user_id: { type: 'string', format: 'uuid' },
4861
4847
  full_name: { type: 'string' },
4862
4848
  email: { type: 'string', format: 'email' },
4863
4849
  phone_number: { type: 'string', nullable: true },
4864
4850
  },
4851
+ required: ['acs_user_id'],
4865
4852
  },
4866
4853
  },
4867
4854
  },
@@ -4900,10 +4887,12 @@ export default {
4900
4887
  schema: {
4901
4888
  type: 'object',
4902
4889
  properties: {
4890
+ acs_user_id: { type: 'string', format: 'uuid' },
4903
4891
  full_name: { type: 'string' },
4904
4892
  email: { type: 'string', format: 'email' },
4905
4893
  phone_number: { type: 'string', nullable: true },
4906
4894
  },
4895
+ required: ['acs_user_id'],
4907
4896
  },
4908
4897
  },
4909
4898
  },
@@ -7398,6 +7387,64 @@ export default {
7398
7387
  'connect_partner_name',
7399
7388
  ],
7400
7389
  },
7390
+ acs_system: {
7391
+ type: 'object',
7392
+ properties: {
7393
+ acs_system_id: { type: 'string', format: 'uuid' },
7394
+ system_type: { type: 'string', enum: ['pti_site', 'alta_org'] },
7395
+ system_type_display_name: { type: 'string' },
7396
+ name: { type: 'string' },
7397
+ created_at: { type: 'string', format: 'date-time' },
7398
+ },
7399
+ required: [
7400
+ 'acs_system_id',
7401
+ 'system_type',
7402
+ 'system_type_display_name',
7403
+ 'name',
7404
+ 'created_at',
7405
+ ],
7406
+ },
7407
+ acs_access_group: {
7408
+ type: 'object',
7409
+ properties: {
7410
+ acs_access_group_id: { type: 'string', format: 'uuid' },
7411
+ acs_system_id: { type: 'string', format: 'uuid' },
7412
+ workspace_id: { type: 'string', format: 'uuid' },
7413
+ name: { type: 'string' },
7414
+ access_group_type: { type: 'string', enum: ['pti_unit'] },
7415
+ access_group_type_display_name: { type: 'string' },
7416
+ created_at: { type: 'string', format: 'date-time' },
7417
+ },
7418
+ required: [
7419
+ 'acs_access_group_id',
7420
+ 'acs_system_id',
7421
+ 'workspace_id',
7422
+ 'name',
7423
+ 'access_group_type',
7424
+ 'access_group_type_display_name',
7425
+ 'created_at',
7426
+ ],
7427
+ },
7428
+ acs_user: {
7429
+ type: 'object',
7430
+ properties: {
7431
+ acs_user_id: { type: 'string', format: 'uuid' },
7432
+ acs_system_id: { type: 'string', format: 'uuid' },
7433
+ workspace_id: { type: 'string', format: 'uuid' },
7434
+ created_at: { type: 'string', format: 'date-time' },
7435
+ display_name: { type: 'string' },
7436
+ full_name: { type: 'string' },
7437
+ email: { type: 'string', format: 'email' },
7438
+ phone_number: { type: 'string', nullable: true },
7439
+ },
7440
+ required: [
7441
+ 'acs_user_id',
7442
+ 'acs_system_id',
7443
+ 'workspace_id',
7444
+ 'created_at',
7445
+ 'display_name',
7446
+ ],
7447
+ },
7401
7448
  },
7402
7449
  },
7403
7450
  }