@seamapi/types 1.683.0 → 1.684.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.
@@ -1937,24 +1937,50 @@ export default {
1937
1937
  description: 'Warnings associated with the `acs_access_group`.',
1938
1938
  items: {
1939
1939
  description: 'Warning associated with the `acs_access_group`.',
1940
- properties: {
1941
- created_at: {
1942
- description: 'Date and time at which Seam created the warning.',
1943
- format: 'date-time',
1944
- type: 'string',
1945
- },
1946
- message: {
1947
- description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
1948
- type: 'string',
1940
+ oneOf: [
1941
+ {
1942
+ description: '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.',
1943
+ properties: {
1944
+ created_at: {
1945
+ description: 'Date and time at which Seam created the warning.',
1946
+ format: 'date-time',
1947
+ type: 'string',
1948
+ },
1949
+ message: {
1950
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
1951
+ type: 'string',
1952
+ },
1953
+ warning_code: {
1954
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
1955
+ enum: ['unknown_issue_with_acs_access_group'],
1956
+ type: 'string',
1957
+ },
1958
+ },
1959
+ required: ['created_at', 'message', 'warning_code'],
1960
+ type: 'object',
1949
1961
  },
1950
- warning_code: {
1951
- description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
1952
- enum: ['unknown_issue_with_acs_access_group'],
1953
- type: 'string',
1962
+ {
1963
+ description: '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.',
1964
+ properties: {
1965
+ created_at: {
1966
+ description: 'Date and time at which Seam created the warning.',
1967
+ format: 'date-time',
1968
+ type: 'string',
1969
+ },
1970
+ message: {
1971
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
1972
+ type: 'string',
1973
+ },
1974
+ warning_code: {
1975
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
1976
+ enum: ['being_deleted'],
1977
+ type: 'string',
1978
+ },
1979
+ },
1980
+ required: ['created_at', 'message', 'warning_code'],
1981
+ type: 'object',
1954
1982
  },
1955
- },
1956
- required: ['created_at', 'message', 'warning_code'],
1957
- type: 'object',
1983
+ ],
1958
1984
  },
1959
1985
  type: 'array',
1960
1986
  },
@@ -21009,24 +21035,50 @@ export default {
21009
21035
  description: 'Warnings associated with the `acs_access_group`.',
21010
21036
  items: {
21011
21037
  description: 'Warning associated with the `acs_access_group`.',
21012
- properties: {
21013
- created_at: {
21014
- description: 'Date and time at which Seam created the warning.',
21015
- format: 'date-time',
21016
- type: 'string',
21017
- },
21018
- message: {
21019
- description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
21020
- type: 'string',
21038
+ oneOf: [
21039
+ {
21040
+ description: '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.',
21041
+ properties: {
21042
+ created_at: {
21043
+ description: 'Date and time at which Seam created the warning.',
21044
+ format: 'date-time',
21045
+ type: 'string',
21046
+ },
21047
+ message: {
21048
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
21049
+ type: 'string',
21050
+ },
21051
+ warning_code: {
21052
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
21053
+ enum: ['unknown_issue_with_acs_access_group'],
21054
+ type: 'string',
21055
+ },
21056
+ },
21057
+ required: ['created_at', 'message', 'warning_code'],
21058
+ type: 'object',
21021
21059
  },
21022
- warning_code: {
21023
- description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
21024
- enum: ['unknown_issue_with_acs_access_group'],
21025
- type: 'string',
21060
+ {
21061
+ description: '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.',
21062
+ properties: {
21063
+ created_at: {
21064
+ description: 'Date and time at which Seam created the warning.',
21065
+ format: 'date-time',
21066
+ type: 'string',
21067
+ },
21068
+ message: {
21069
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
21070
+ type: 'string',
21071
+ },
21072
+ warning_code: {
21073
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
21074
+ enum: ['being_deleted'],
21075
+ type: 'string',
21076
+ },
21077
+ },
21078
+ required: ['created_at', 'message', 'warning_code'],
21079
+ type: 'object',
21026
21080
  },
21027
- },
21028
- required: ['created_at', 'message', 'warning_code'],
21029
- type: 'object',
21081
+ ],
21030
21082
  },
21031
21083
  type: 'array',
21032
21084
  },
@@ -29574,6 +29626,101 @@ export default {
29574
29626
  'x-title': 'Add an ACS User to an Access Group',
29575
29627
  },
29576
29628
  },
29629
+ '/acs/access_groups/delete': {
29630
+ delete: {
29631
+ description: 'Deletes a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).',
29632
+ operationId: 'acsAccessGroupsDeleteDelete',
29633
+ parameters: [
29634
+ {
29635
+ in: 'query',
29636
+ name: 'acs_access_group_id',
29637
+ required: true,
29638
+ schema: {
29639
+ description: 'ID of the access group that you want to delete.',
29640
+ format: 'uuid',
29641
+ type: 'string',
29642
+ },
29643
+ },
29644
+ ],
29645
+ responses: {
29646
+ 200: {
29647
+ content: {
29648
+ 'application/json': {
29649
+ schema: {
29650
+ properties: { ok: { type: 'boolean' } },
29651
+ required: ['ok'],
29652
+ type: 'object',
29653
+ },
29654
+ },
29655
+ },
29656
+ description: 'OK',
29657
+ },
29658
+ 400: { description: 'Bad Request' },
29659
+ 401: { description: 'Unauthorized' },
29660
+ },
29661
+ security: [
29662
+ { client_session: [] },
29663
+ { pat_with_workspace: [] },
29664
+ { console_session_with_workspace: [] },
29665
+ { api_key: [] },
29666
+ ],
29667
+ summary: '/acs/access_groups/delete',
29668
+ tags: ['/acs'],
29669
+ 'x-fern-sdk-group-name': ['acs', 'access_groups'],
29670
+ 'x-fern-sdk-method-name': 'delete',
29671
+ 'x-response-key': null,
29672
+ 'x-title': 'Delete an Access Group',
29673
+ },
29674
+ post: {
29675
+ description: 'Deletes a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).',
29676
+ operationId: 'acsAccessGroupsDeletePost',
29677
+ requestBody: {
29678
+ content: {
29679
+ 'application/json': {
29680
+ schema: {
29681
+ properties: {
29682
+ acs_access_group_id: {
29683
+ description: 'ID of the access group that you want to delete.',
29684
+ format: 'uuid',
29685
+ type: 'string',
29686
+ },
29687
+ },
29688
+ required: ['acs_access_group_id'],
29689
+ type: 'object',
29690
+ },
29691
+ },
29692
+ },
29693
+ },
29694
+ responses: {
29695
+ 200: {
29696
+ content: {
29697
+ 'application/json': {
29698
+ schema: {
29699
+ properties: { ok: { type: 'boolean' } },
29700
+ required: ['ok'],
29701
+ type: 'object',
29702
+ },
29703
+ },
29704
+ },
29705
+ description: 'OK',
29706
+ },
29707
+ 400: { description: 'Bad Request' },
29708
+ 401: { description: 'Unauthorized' },
29709
+ },
29710
+ security: [
29711
+ { client_session: [] },
29712
+ { pat_with_workspace: [] },
29713
+ { console_session_with_workspace: [] },
29714
+ { api_key: [] },
29715
+ ],
29716
+ summary: '/acs/access_groups/delete',
29717
+ tags: ['/acs'],
29718
+ 'x-fern-sdk-group-name': ['acs', 'access_groups'],
29719
+ 'x-fern-sdk-method-name': 'delete',
29720
+ 'x-response-key': null,
29721
+ 'x-title': 'Delete an Access Group',
29722
+ },
29723
+ },
29577
29724
  '/acs/access_groups/get': {
29578
29725
  get: {
29579
29726
  description: 'Returns a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).',