@seamapi/types 1.683.0 → 1.685.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.
@@ -11971,14 +11971,21 @@ export type Routes = {
11971
11971
  /** Date and time at which the access group was created. */
11972
11972
  created_at: string;
11973
11973
  /** Warnings associated with the `acs_access_group`. */
11974
- warnings: {
11974
+ warnings: ({
11975
11975
  /** Date and time at which Seam created the warning. */
11976
11976
  created_at: string;
11977
11977
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
11978
11978
  message: string;
11979
11979
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
11980
11980
  warning_code: 'unknown_issue_with_acs_access_group';
11981
- }[];
11981
+ } | {
11982
+ /** Date and time at which Seam created the warning. */
11983
+ created_at: string;
11984
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
11985
+ message: string;
11986
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
11987
+ warning_code: 'being_deleted';
11988
+ })[];
11982
11989
  is_managed: true;
11983
11990
  }[] | undefined;
11984
11991
  };
@@ -15494,6 +15501,19 @@ export type Routes = {
15494
15501
  jsonResponse: {};
15495
15502
  maxDuration: undefined;
15496
15503
  };
15504
+ '/acs/access_groups/delete': {
15505
+ route: '/acs/access_groups/delete';
15506
+ method: 'DELETE' | 'POST';
15507
+ queryParams: {};
15508
+ jsonBody: {};
15509
+ commonParams: {
15510
+ /** ID of the access group that you want to delete. */
15511
+ acs_access_group_id: string;
15512
+ };
15513
+ formData: {};
15514
+ jsonResponse: {};
15515
+ maxDuration: undefined;
15516
+ };
15497
15517
  '/acs/access_groups/get': {
15498
15518
  route: '/acs/access_groups/get';
15499
15519
  method: 'GET' | 'POST';
@@ -15535,14 +15555,21 @@ export type Routes = {
15535
15555
  /** Date and time at which the access group was created. */
15536
15556
  created_at: string;
15537
15557
  /** Warnings associated with the `acs_access_group`. */
15538
- warnings: {
15558
+ warnings: ({
15539
15559
  /** Date and time at which Seam created the warning. */
15540
15560
  created_at: string;
15541
15561
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
15542
15562
  message: string;
15543
15563
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
15544
15564
  warning_code: 'unknown_issue_with_acs_access_group';
15545
- }[];
15565
+ } | {
15566
+ /** Date and time at which Seam created the warning. */
15567
+ created_at: string;
15568
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
15569
+ message: string;
15570
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
15571
+ warning_code: 'being_deleted';
15572
+ })[];
15546
15573
  is_managed: true;
15547
15574
  };
15548
15575
  };
@@ -15588,14 +15615,21 @@ export type Routes = {
15588
15615
  /** Date and time at which the access group was created. */
15589
15616
  created_at: string;
15590
15617
  /** Warnings associated with the `acs_access_group`. */
15591
- warnings: {
15618
+ warnings: ({
15592
15619
  /** Date and time at which Seam created the warning. */
15593
15620
  created_at: string;
15594
15621
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
15595
15622
  message: string;
15596
15623
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
15597
15624
  warning_code: 'unknown_issue_with_acs_access_group';
15598
- }[];
15625
+ } | {
15626
+ /** Date and time at which Seam created the warning. */
15627
+ created_at: string;
15628
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
15629
+ message: string;
15630
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
15631
+ warning_code: 'being_deleted';
15632
+ })[];
15599
15633
  is_managed: true;
15600
15634
  }[];
15601
15635
  };
@@ -16030,14 +16064,21 @@ export type Routes = {
16030
16064
  /** Date and time at which the access group was created. */
16031
16065
  created_at: string;
16032
16066
  /** Warnings associated with the `acs_access_group`. */
16033
- warnings: {
16067
+ warnings: ({
16034
16068
  /** Date and time at which Seam created the warning. */
16035
16069
  created_at: string;
16036
16070
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
16037
16071
  message: string;
16038
16072
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
16039
16073
  warning_code: 'unknown_issue_with_acs_access_group';
16040
- }[];
16074
+ } | {
16075
+ /** Date and time at which Seam created the warning. */
16076
+ created_at: string;
16077
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
16078
+ message: string;
16079
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
16080
+ warning_code: 'being_deleted';
16081
+ })[];
16041
16082
  is_managed: false;
16042
16083
  };
16043
16084
  };
@@ -16081,14 +16122,21 @@ export type Routes = {
16081
16122
  /** Date and time at which the access group was created. */
16082
16123
  created_at: string;
16083
16124
  /** Warnings associated with the `acs_access_group`. */
16084
- warnings: {
16125
+ warnings: ({
16085
16126
  /** Date and time at which Seam created the warning. */
16086
16127
  created_at: string;
16087
16128
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
16088
16129
  message: string;
16089
16130
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
16090
16131
  warning_code: 'unknown_issue_with_acs_access_group';
16091
- }[];
16132
+ } | {
16133
+ /** Date and time at which Seam created the warning. */
16134
+ created_at: string;
16135
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
16136
+ message: string;
16137
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
16138
+ warning_code: 'being_deleted';
16139
+ })[];
16092
16140
  is_managed: false;
16093
16141
  }[];
16094
16142
  };
@@ -52552,7 +52600,7 @@ export type Routes = {
52552
52600
  queryParams: {};
52553
52601
  jsonBody: {
52554
52602
  /** Type of connector to create */
52555
- connector_type: 'mock' | 'mews' | 'rms' | 'cloudbeds' | 'smoobu';
52603
+ connector_type: 'mock' | 'mews' | 'rms' | 'cloudbeds' | 'smoobu' | 'zonal';
52556
52604
  /** Key identifying the customer */
52557
52605
  customer_key?: string | undefined;
52558
52606
  /** Instance-specific configuration for the connector */
@@ -79142,14 +79190,21 @@ export type Routes = {
79142
79190
  /** Date and time at which the access group was created. */
79143
79191
  created_at: string;
79144
79192
  /** Warnings associated with the `acs_access_group`. */
79145
- warnings: {
79193
+ warnings: ({
79146
79194
  /** Date and time at which Seam created the warning. */
79147
79195
  created_at: string;
79148
79196
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
79149
79197
  message: string;
79150
79198
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
79151
79199
  warning_code: 'unknown_issue_with_acs_access_group';
79152
- }[];
79200
+ } | {
79201
+ /** Date and time at which Seam created the warning. */
79202
+ created_at: string;
79203
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
79204
+ message: string;
79205
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
79206
+ warning_code: 'being_deleted';
79207
+ })[];
79153
79208
  is_managed: true;
79154
79209
  }[] | undefined;
79155
79210
  acs_encoders?: {
@@ -80701,14 +80756,21 @@ export type Routes = {
80701
80756
  /** Date and time at which the access group was created. */
80702
80757
  created_at: string;
80703
80758
  /** Warnings associated with the `acs_access_group`. */
80704
- warnings: {
80759
+ warnings: ({
80705
80760
  /** Date and time at which Seam created the warning. */
80706
80761
  created_at: string;
80707
80762
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
80708
80763
  message: string;
80709
80764
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
80710
80765
  warning_code: 'unknown_issue_with_acs_access_group';
80711
- }[];
80766
+ } | {
80767
+ /** Date and time at which Seam created the warning. */
80768
+ created_at: string;
80769
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
80770
+ message: string;
80771
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
80772
+ warning_code: 'being_deleted';
80773
+ })[];
80712
80774
  is_managed: false;
80713
80775
  }[] | undefined;
80714
80776
  unmanaged_devices?: {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.683.0",
3
+ "version": "1.685.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -41,14 +41,23 @@ export const unknown_issue_with_acs_access_group =
41
41
  'An unknown issue occurred while syncing the state of this access group with the provider. This issue may affect the proper functioning of this access group.',
42
42
  )
43
43
 
44
- const acs_access_group_warning = unknown_issue_with_acs_access_group.describe(
45
- 'Warning associated with the `acs_access_group`.',
46
- )
44
+ const acs_access_group_being_deleted = common_acs_access_group_warning
45
+ .extend({
46
+ warning_code: z.literal('being_deleted').describe(warning_code_description),
47
+ })
48
+ .describe(
49
+ 'Indicates that the access group is being deleted from the access system. This is a temporary state, and the access group will be deleted shortly.',
50
+ )
51
+
52
+ const acs_access_group_warning = z
53
+ .union([unknown_issue_with_acs_access_group, acs_access_group_being_deleted])
54
+ .describe('Warning associated with the `acs_access_group`.')
47
55
 
48
56
  const _acs_access_group_warning_map = z.object({
49
57
  unknown_issue_with_acs_access_group: unknown_issue_with_acs_access_group
50
58
  .optional()
51
59
  .nullable(),
60
+ being_deleted: acs_access_group_being_deleted.optional().nullable(),
52
61
  })
53
62
 
54
63
  export type AcsAccessGroupWarningMap = z.infer<
@@ -2227,27 +2227,58 @@ export default {
2227
2227
  description: 'Warnings associated with the `acs_access_group`.',
2228
2228
  items: {
2229
2229
  description: 'Warning associated with the `acs_access_group`.',
2230
- properties: {
2231
- created_at: {
2232
- description:
2233
- 'Date and time at which Seam created the warning.',
2234
- format: 'date-time',
2235
- type: 'string',
2236
- },
2237
- message: {
2230
+ oneOf: [
2231
+ {
2238
2232
  description:
2239
- 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
2240
- type: 'string',
2233
+ 'An unknown issue occurred while syncing the state of this access group with the provider. This issue may affect the proper functioning of this access group.',
2234
+ properties: {
2235
+ created_at: {
2236
+ description:
2237
+ 'Date and time at which Seam created the warning.',
2238
+ format: 'date-time',
2239
+ type: 'string',
2240
+ },
2241
+ message: {
2242
+ description:
2243
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
2244
+ type: 'string',
2245
+ },
2246
+ warning_code: {
2247
+ description:
2248
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
2249
+ enum: ['unknown_issue_with_acs_access_group'],
2250
+ type: 'string',
2251
+ },
2252
+ },
2253
+ required: ['created_at', 'message', 'warning_code'],
2254
+ type: 'object',
2241
2255
  },
2242
- warning_code: {
2256
+ {
2243
2257
  description:
2244
- 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
2245
- enum: ['unknown_issue_with_acs_access_group'],
2246
- type: 'string',
2258
+ 'Indicates that the access group is being deleted from the access system. This is a temporary state, and the access group will be deleted shortly.',
2259
+ properties: {
2260
+ created_at: {
2261
+ description:
2262
+ 'Date and time at which Seam created the warning.',
2263
+ format: 'date-time',
2264
+ type: 'string',
2265
+ },
2266
+ message: {
2267
+ description:
2268
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
2269
+ type: 'string',
2270
+ },
2271
+ warning_code: {
2272
+ description:
2273
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
2274
+ enum: ['being_deleted'],
2275
+ type: 'string',
2276
+ },
2277
+ },
2278
+ required: ['created_at', 'message', 'warning_code'],
2279
+ type: 'object',
2247
2280
  },
2248
- },
2249
- required: ['created_at', 'message', 'warning_code'],
2250
- type: 'object',
2281
+ ],
2251
2282
  },
2252
2283
  type: 'array',
2253
2284
  },
@@ -23421,27 +23452,58 @@ export default {
23421
23452
  description: 'Warnings associated with the `acs_access_group`.',
23422
23453
  items: {
23423
23454
  description: 'Warning associated with the `acs_access_group`.',
23424
- properties: {
23425
- created_at: {
23426
- description:
23427
- 'Date and time at which Seam created the warning.',
23428
- format: 'date-time',
23429
- type: 'string',
23430
- },
23431
- message: {
23455
+ oneOf: [
23456
+ {
23432
23457
  description:
23433
- 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
23434
- type: 'string',
23458
+ 'An unknown issue occurred while syncing the state of this access group with the provider. This issue may affect the proper functioning of this access group.',
23459
+ properties: {
23460
+ created_at: {
23461
+ description:
23462
+ 'Date and time at which Seam created the warning.',
23463
+ format: 'date-time',
23464
+ type: 'string',
23465
+ },
23466
+ message: {
23467
+ description:
23468
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
23469
+ type: 'string',
23470
+ },
23471
+ warning_code: {
23472
+ description:
23473
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
23474
+ enum: ['unknown_issue_with_acs_access_group'],
23475
+ type: 'string',
23476
+ },
23477
+ },
23478
+ required: ['created_at', 'message', 'warning_code'],
23479
+ type: 'object',
23435
23480
  },
23436
- warning_code: {
23481
+ {
23437
23482
  description:
23438
- 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
23439
- enum: ['unknown_issue_with_acs_access_group'],
23440
- type: 'string',
23483
+ 'Indicates that the access group is being deleted from the access system. This is a temporary state, and the access group will be deleted shortly.',
23484
+ properties: {
23485
+ created_at: {
23486
+ description:
23487
+ 'Date and time at which Seam created the warning.',
23488
+ format: 'date-time',
23489
+ type: 'string',
23490
+ },
23491
+ message: {
23492
+ description:
23493
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
23494
+ type: 'string',
23495
+ },
23496
+ warning_code: {
23497
+ description:
23498
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
23499
+ enum: ['being_deleted'],
23500
+ type: 'string',
23501
+ },
23502
+ },
23503
+ required: ['created_at', 'message', 'warning_code'],
23504
+ type: 'object',
23441
23505
  },
23442
- },
23443
- required: ['created_at', 'message', 'warning_code'],
23444
- type: 'object',
23506
+ ],
23445
23507
  },
23446
23508
  type: 'array',
23447
23509
  },
@@ -32761,6 +32823,104 @@ export default {
32761
32823
  'x-title': 'Add an ACS User to an Access Group',
32762
32824
  },
32763
32825
  },
32826
+ '/acs/access_groups/delete': {
32827
+ delete: {
32828
+ description:
32829
+ 'Deletes a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).',
32830
+ operationId: 'acsAccessGroupsDeleteDelete',
32831
+ parameters: [
32832
+ {
32833
+ in: 'query',
32834
+ name: 'acs_access_group_id',
32835
+ required: true,
32836
+ schema: {
32837
+ description: 'ID of the access group that you want to delete.',
32838
+ format: 'uuid',
32839
+ type: 'string',
32840
+ },
32841
+ },
32842
+ ],
32843
+ responses: {
32844
+ 200: {
32845
+ content: {
32846
+ 'application/json': {
32847
+ schema: {
32848
+ properties: { ok: { type: 'boolean' } },
32849
+ required: ['ok'],
32850
+ type: 'object',
32851
+ },
32852
+ },
32853
+ },
32854
+ description: 'OK',
32855
+ },
32856
+ 400: { description: 'Bad Request' },
32857
+ 401: { description: 'Unauthorized' },
32858
+ },
32859
+ security: [
32860
+ { client_session: [] },
32861
+ { pat_with_workspace: [] },
32862
+ { console_session_with_workspace: [] },
32863
+ { api_key: [] },
32864
+ ],
32865
+ summary: '/acs/access_groups/delete',
32866
+ tags: ['/acs'],
32867
+ 'x-fern-sdk-group-name': ['acs', 'access_groups'],
32868
+ 'x-fern-sdk-method-name': 'delete',
32869
+ 'x-response-key': null,
32870
+ 'x-title': 'Delete an Access Group',
32871
+ },
32872
+ post: {
32873
+ description:
32874
+ 'Deletes a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).',
32875
+ operationId: 'acsAccessGroupsDeletePost',
32876
+ requestBody: {
32877
+ content: {
32878
+ 'application/json': {
32879
+ schema: {
32880
+ properties: {
32881
+ acs_access_group_id: {
32882
+ description:
32883
+ 'ID of the access group that you want to delete.',
32884
+ format: 'uuid',
32885
+ type: 'string',
32886
+ },
32887
+ },
32888
+ required: ['acs_access_group_id'],
32889
+ type: 'object',
32890
+ },
32891
+ },
32892
+ },
32893
+ },
32894
+ responses: {
32895
+ 200: {
32896
+ content: {
32897
+ 'application/json': {
32898
+ schema: {
32899
+ properties: { ok: { type: 'boolean' } },
32900
+ required: ['ok'],
32901
+ type: 'object',
32902
+ },
32903
+ },
32904
+ },
32905
+ description: 'OK',
32906
+ },
32907
+ 400: { description: 'Bad Request' },
32908
+ 401: { description: 'Unauthorized' },
32909
+ },
32910
+ security: [
32911
+ { client_session: [] },
32912
+ { pat_with_workspace: [] },
32913
+ { console_session_with_workspace: [] },
32914
+ { api_key: [] },
32915
+ ],
32916
+ summary: '/acs/access_groups/delete',
32917
+ tags: ['/acs'],
32918
+ 'x-fern-sdk-group-name': ['acs', 'access_groups'],
32919
+ 'x-fern-sdk-method-name': 'delete',
32920
+ 'x-response-key': null,
32921
+ 'x-title': 'Delete an Access Group',
32922
+ },
32923
+ },
32764
32924
  '/acs/access_groups/get': {
32765
32925
  get: {
32766
32926
  description:
@@ -54029,7 +54189,14 @@ export default {
54029
54189
  },
54030
54190
  connector_type: {
54031
54191
  description: 'Type of connector to create',
54032
- enum: ['mock', 'mews', 'rms', 'cloudbeds', 'smoobu'],
54192
+ enum: [
54193
+ 'mock',
54194
+ 'mews',
54195
+ 'rms',
54196
+ 'cloudbeds',
54197
+ 'smoobu',
54198
+ 'zonal',
54199
+ ],
54033
54200
  type: 'string',
54034
54201
  },
54035
54202
  customer_key: {