@seamapi/types 1.593.0 → 1.595.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.
- package/dist/connect.cjs +317 -0
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +639 -99
- package/dist/index.cjs +317 -0
- package/dist/index.cjs.map +1 -1
- package/lib/seam/connect/openapi.d.ts +432 -0
- package/lib/seam/connect/openapi.js +317 -0
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +108 -0
- package/package.json +1 -1
- package/src/lib/seam/connect/openapi.ts +336 -0
- package/src/lib/seam/connect/route-types.ts +108 -0
|
@@ -26209,6 +26209,85 @@ export default {
|
|
|
26209
26209
|
'x-title': 'List Access Grants',
|
|
26210
26210
|
},
|
|
26211
26211
|
},
|
|
26212
|
+
'/access_grants/request_access_methods': {
|
|
26213
|
+
post: {
|
|
26214
|
+
description: 'Adds additional requested access methods to an existing Access Grant.',
|
|
26215
|
+
operationId: 'accessGrantsRequestAccessMethodsPost',
|
|
26216
|
+
requestBody: {
|
|
26217
|
+
content: {
|
|
26218
|
+
'application/json': {
|
|
26219
|
+
schema: {
|
|
26220
|
+
properties: {
|
|
26221
|
+
access_grant_id: {
|
|
26222
|
+
description: 'ID of the Access Grant to add access methods to.',
|
|
26223
|
+
format: 'uuid',
|
|
26224
|
+
type: 'string',
|
|
26225
|
+
},
|
|
26226
|
+
requested_access_methods: {
|
|
26227
|
+
description: 'Array of requested access methods to add to the access grant.',
|
|
26228
|
+
items: {
|
|
26229
|
+
properties: {
|
|
26230
|
+
code: {
|
|
26231
|
+
description: "Specific PIN code to use for this access method. Only applicable when mode is 'code'.",
|
|
26232
|
+
maxLength: 9,
|
|
26233
|
+
minLength: 4,
|
|
26234
|
+
pattern: '^\\d+$',
|
|
26235
|
+
type: 'string',
|
|
26236
|
+
},
|
|
26237
|
+
mode: {
|
|
26238
|
+
description: 'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
|
|
26239
|
+
enum: ['code', 'card', 'mobile_key'],
|
|
26240
|
+
type: 'string',
|
|
26241
|
+
},
|
|
26242
|
+
},
|
|
26243
|
+
required: ['mode'],
|
|
26244
|
+
type: 'object',
|
|
26245
|
+
},
|
|
26246
|
+
minItems: 1,
|
|
26247
|
+
type: 'array',
|
|
26248
|
+
},
|
|
26249
|
+
},
|
|
26250
|
+
required: ['access_grant_id', 'requested_access_methods'],
|
|
26251
|
+
type: 'object',
|
|
26252
|
+
},
|
|
26253
|
+
},
|
|
26254
|
+
},
|
|
26255
|
+
},
|
|
26256
|
+
responses: {
|
|
26257
|
+
200: {
|
|
26258
|
+
content: {
|
|
26259
|
+
'application/json': {
|
|
26260
|
+
schema: {
|
|
26261
|
+
properties: {
|
|
26262
|
+
access_grant: { $ref: '#/components/schemas/access_grant' },
|
|
26263
|
+
ok: { type: 'boolean' },
|
|
26264
|
+
},
|
|
26265
|
+
required: ['access_grant', 'ok'],
|
|
26266
|
+
type: 'object',
|
|
26267
|
+
},
|
|
26268
|
+
},
|
|
26269
|
+
},
|
|
26270
|
+
description: 'OK',
|
|
26271
|
+
},
|
|
26272
|
+
400: { description: 'Bad Request' },
|
|
26273
|
+
401: { description: 'Unauthorized' },
|
|
26274
|
+
},
|
|
26275
|
+
security: [
|
|
26276
|
+
{ pat_with_workspace: [] },
|
|
26277
|
+
{ console_session_with_workspace: [] },
|
|
26278
|
+
{ api_key: [] },
|
|
26279
|
+
{ client_session_with_customer: [] },
|
|
26280
|
+
],
|
|
26281
|
+
summary: '/access_grants/request_access_methods',
|
|
26282
|
+
tags: [],
|
|
26283
|
+
'x-draft': 'Early access.',
|
|
26284
|
+
'x-fern-sdk-group-name': ['access_grants'],
|
|
26285
|
+
'x-fern-sdk-method-name': 'request_access_methods',
|
|
26286
|
+
'x-fern-sdk-return-value': 'access_grant',
|
|
26287
|
+
'x-response-key': 'access_grant',
|
|
26288
|
+
'x-title': 'Add Requested Access Methods to Access Grant',
|
|
26289
|
+
},
|
|
26290
|
+
},
|
|
26212
26291
|
'/access_grants/unmanaged/get': {
|
|
26213
26292
|
get: {
|
|
26214
26293
|
description: 'Get an unmanaged Access Grant (where is_managed = false).',
|
|
@@ -27067,6 +27146,126 @@ export default {
|
|
|
27067
27146
|
'x-title': 'List Unmanaged Access Grants',
|
|
27068
27147
|
},
|
|
27069
27148
|
},
|
|
27149
|
+
'/access_grants/unmanaged/update': {
|
|
27150
|
+
patch: {
|
|
27151
|
+
description: 'Updates an unmanaged Access Grant to make it managed.\n\nThis endpoint can only be used to convert unmanaged access grants to managed ones by setting `is_managed` to `true`. It cannot be used to convert managed access grants back to unmanaged.\n\nWhen converting an unmanaged access grant to managed, all associated access methods will also be converted to managed.',
|
|
27152
|
+
operationId: 'accessGrantsUnmanagedUpdatePatch',
|
|
27153
|
+
requestBody: {
|
|
27154
|
+
content: {
|
|
27155
|
+
'application/json': {
|
|
27156
|
+
schema: {
|
|
27157
|
+
properties: {
|
|
27158
|
+
access_grant_id: {
|
|
27159
|
+
description: 'ID of the unmanaged Access Grant to update.',
|
|
27160
|
+
format: 'uuid',
|
|
27161
|
+
type: 'string',
|
|
27162
|
+
},
|
|
27163
|
+
access_grant_key: {
|
|
27164
|
+
description: 'Unique key for the access grant. If not provided, the existing key will be preserved.',
|
|
27165
|
+
type: 'string',
|
|
27166
|
+
},
|
|
27167
|
+
is_managed: {
|
|
27168
|
+
description: 'Must be set to true to convert the unmanaged access grant to managed.',
|
|
27169
|
+
enum: [true],
|
|
27170
|
+
type: 'boolean',
|
|
27171
|
+
},
|
|
27172
|
+
},
|
|
27173
|
+
required: ['access_grant_id', 'is_managed'],
|
|
27174
|
+
type: 'object',
|
|
27175
|
+
},
|
|
27176
|
+
},
|
|
27177
|
+
},
|
|
27178
|
+
},
|
|
27179
|
+
responses: {
|
|
27180
|
+
200: {
|
|
27181
|
+
content: {
|
|
27182
|
+
'application/json': {
|
|
27183
|
+
schema: {
|
|
27184
|
+
properties: { ok: { type: 'boolean' } },
|
|
27185
|
+
required: ['ok'],
|
|
27186
|
+
type: 'object',
|
|
27187
|
+
},
|
|
27188
|
+
},
|
|
27189
|
+
},
|
|
27190
|
+
description: 'OK',
|
|
27191
|
+
},
|
|
27192
|
+
400: { description: 'Bad Request' },
|
|
27193
|
+
401: { description: 'Unauthorized' },
|
|
27194
|
+
},
|
|
27195
|
+
security: [
|
|
27196
|
+
{ pat_with_workspace: [] },
|
|
27197
|
+
{ console_session_with_workspace: [] },
|
|
27198
|
+
{ api_key: [] },
|
|
27199
|
+
{ client_session_with_customer: [] },
|
|
27200
|
+
],
|
|
27201
|
+
summary: '/access_grants/unmanaged/update',
|
|
27202
|
+
tags: [],
|
|
27203
|
+
'x-draft': 'Early access.',
|
|
27204
|
+
'x-fern-sdk-group-name': ['access_grants', 'unmanaged'],
|
|
27205
|
+
'x-fern-sdk-method-name': 'update',
|
|
27206
|
+
'x-response-key': null,
|
|
27207
|
+
'x-title': 'Update an Unmanaged Access Grant',
|
|
27208
|
+
},
|
|
27209
|
+
post: {
|
|
27210
|
+
description: 'Updates an unmanaged Access Grant to make it managed.\n\nThis endpoint can only be used to convert unmanaged access grants to managed ones by setting `is_managed` to `true`. It cannot be used to convert managed access grants back to unmanaged.\n\nWhen converting an unmanaged access grant to managed, all associated access methods will also be converted to managed.',
|
|
27211
|
+
operationId: 'accessGrantsUnmanagedUpdatePost',
|
|
27212
|
+
requestBody: {
|
|
27213
|
+
content: {
|
|
27214
|
+
'application/json': {
|
|
27215
|
+
schema: {
|
|
27216
|
+
properties: {
|
|
27217
|
+
access_grant_id: {
|
|
27218
|
+
description: 'ID of the unmanaged Access Grant to update.',
|
|
27219
|
+
format: 'uuid',
|
|
27220
|
+
type: 'string',
|
|
27221
|
+
},
|
|
27222
|
+
access_grant_key: {
|
|
27223
|
+
description: 'Unique key for the access grant. If not provided, the existing key will be preserved.',
|
|
27224
|
+
type: 'string',
|
|
27225
|
+
},
|
|
27226
|
+
is_managed: {
|
|
27227
|
+
description: 'Must be set to true to convert the unmanaged access grant to managed.',
|
|
27228
|
+
enum: [true],
|
|
27229
|
+
type: 'boolean',
|
|
27230
|
+
},
|
|
27231
|
+
},
|
|
27232
|
+
required: ['access_grant_id', 'is_managed'],
|
|
27233
|
+
type: 'object',
|
|
27234
|
+
},
|
|
27235
|
+
},
|
|
27236
|
+
},
|
|
27237
|
+
},
|
|
27238
|
+
responses: {
|
|
27239
|
+
200: {
|
|
27240
|
+
content: {
|
|
27241
|
+
'application/json': {
|
|
27242
|
+
schema: {
|
|
27243
|
+
properties: { ok: { type: 'boolean' } },
|
|
27244
|
+
required: ['ok'],
|
|
27245
|
+
type: 'object',
|
|
27246
|
+
},
|
|
27247
|
+
},
|
|
27248
|
+
},
|
|
27249
|
+
description: 'OK',
|
|
27250
|
+
},
|
|
27251
|
+
400: { description: 'Bad Request' },
|
|
27252
|
+
401: { description: 'Unauthorized' },
|
|
27253
|
+
},
|
|
27254
|
+
security: [
|
|
27255
|
+
{ pat_with_workspace: [] },
|
|
27256
|
+
{ console_session_with_workspace: [] },
|
|
27257
|
+
{ api_key: [] },
|
|
27258
|
+
{ client_session_with_customer: [] },
|
|
27259
|
+
],
|
|
27260
|
+
summary: '/access_grants/unmanaged/update',
|
|
27261
|
+
tags: [],
|
|
27262
|
+
'x-draft': 'Early access.',
|
|
27263
|
+
'x-fern-sdk-group-name': ['access_grants', 'unmanaged'],
|
|
27264
|
+
'x-fern-sdk-method-name': 'update',
|
|
27265
|
+
'x-response-key': null,
|
|
27266
|
+
'x-title': 'Update an Unmanaged Access Grant',
|
|
27267
|
+
},
|
|
27268
|
+
},
|
|
27070
27269
|
'/access_grants/update': {
|
|
27071
27270
|
patch: {
|
|
27072
27271
|
description: "Updates an existing Access Grant's time window.",
|
|
@@ -56774,6 +56973,124 @@ export default {
|
|
|
56774
56973
|
'x-title': 'List Unmanaged User Identities',
|
|
56775
56974
|
},
|
|
56776
56975
|
},
|
|
56976
|
+
'/user_identities/unmanaged/update': {
|
|
56977
|
+
patch: {
|
|
56978
|
+
description: 'Updates an unmanaged [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) to make it managed.\n\nThis endpoint can only be used to convert unmanaged user identities to managed ones by setting `is_managed` to `true`. It cannot be used to convert managed user identities back to unmanaged.',
|
|
56979
|
+
operationId: 'userIdentitiesUnmanagedUpdatePatch',
|
|
56980
|
+
requestBody: {
|
|
56981
|
+
content: {
|
|
56982
|
+
'application/json': {
|
|
56983
|
+
schema: {
|
|
56984
|
+
properties: {
|
|
56985
|
+
is_managed: {
|
|
56986
|
+
description: 'Must be set to true to convert the unmanaged user identity to managed.',
|
|
56987
|
+
enum: [true],
|
|
56988
|
+
type: 'boolean',
|
|
56989
|
+
},
|
|
56990
|
+
user_identity_id: {
|
|
56991
|
+
description: 'ID of the unmanaged user identity that you want to update.',
|
|
56992
|
+
format: 'uuid',
|
|
56993
|
+
type: 'string',
|
|
56994
|
+
},
|
|
56995
|
+
user_identity_key: {
|
|
56996
|
+
description: 'Unique key for the user identity. If not provided, the existing key will be preserved.',
|
|
56997
|
+
type: 'string',
|
|
56998
|
+
},
|
|
56999
|
+
},
|
|
57000
|
+
required: ['user_identity_id', 'is_managed'],
|
|
57001
|
+
type: 'object',
|
|
57002
|
+
},
|
|
57003
|
+
},
|
|
57004
|
+
},
|
|
57005
|
+
},
|
|
57006
|
+
responses: {
|
|
57007
|
+
200: {
|
|
57008
|
+
content: {
|
|
57009
|
+
'application/json': {
|
|
57010
|
+
schema: {
|
|
57011
|
+
properties: { ok: { type: 'boolean' } },
|
|
57012
|
+
required: ['ok'],
|
|
57013
|
+
type: 'object',
|
|
57014
|
+
},
|
|
57015
|
+
},
|
|
57016
|
+
},
|
|
57017
|
+
description: 'OK',
|
|
57018
|
+
},
|
|
57019
|
+
400: { description: 'Bad Request' },
|
|
57020
|
+
401: { description: 'Unauthorized' },
|
|
57021
|
+
},
|
|
57022
|
+
security: [
|
|
57023
|
+
{ api_key: [] },
|
|
57024
|
+
{ client_session: [] },
|
|
57025
|
+
{ pat_with_workspace: [] },
|
|
57026
|
+
{ console_session_with_workspace: [] },
|
|
57027
|
+
],
|
|
57028
|
+
summary: '/user_identities/unmanaged/update',
|
|
57029
|
+
tags: ['/user_identities'],
|
|
57030
|
+
'x-fern-sdk-group-name': ['user_identities', 'unmanaged'],
|
|
57031
|
+
'x-fern-sdk-method-name': 'update',
|
|
57032
|
+
'x-response-key': null,
|
|
57033
|
+
'x-title': 'Update an Unmanaged User Identity',
|
|
57034
|
+
},
|
|
57035
|
+
post: {
|
|
57036
|
+
description: 'Updates an unmanaged [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) to make it managed.\n\nThis endpoint can only be used to convert unmanaged user identities to managed ones by setting `is_managed` to `true`. It cannot be used to convert managed user identities back to unmanaged.',
|
|
57037
|
+
operationId: 'userIdentitiesUnmanagedUpdatePost',
|
|
57038
|
+
requestBody: {
|
|
57039
|
+
content: {
|
|
57040
|
+
'application/json': {
|
|
57041
|
+
schema: {
|
|
57042
|
+
properties: {
|
|
57043
|
+
is_managed: {
|
|
57044
|
+
description: 'Must be set to true to convert the unmanaged user identity to managed.',
|
|
57045
|
+
enum: [true],
|
|
57046
|
+
type: 'boolean',
|
|
57047
|
+
},
|
|
57048
|
+
user_identity_id: {
|
|
57049
|
+
description: 'ID of the unmanaged user identity that you want to update.',
|
|
57050
|
+
format: 'uuid',
|
|
57051
|
+
type: 'string',
|
|
57052
|
+
},
|
|
57053
|
+
user_identity_key: {
|
|
57054
|
+
description: 'Unique key for the user identity. If not provided, the existing key will be preserved.',
|
|
57055
|
+
type: 'string',
|
|
57056
|
+
},
|
|
57057
|
+
},
|
|
57058
|
+
required: ['user_identity_id', 'is_managed'],
|
|
57059
|
+
type: 'object',
|
|
57060
|
+
},
|
|
57061
|
+
},
|
|
57062
|
+
},
|
|
57063
|
+
},
|
|
57064
|
+
responses: {
|
|
57065
|
+
200: {
|
|
57066
|
+
content: {
|
|
57067
|
+
'application/json': {
|
|
57068
|
+
schema: {
|
|
57069
|
+
properties: { ok: { type: 'boolean' } },
|
|
57070
|
+
required: ['ok'],
|
|
57071
|
+
type: 'object',
|
|
57072
|
+
},
|
|
57073
|
+
},
|
|
57074
|
+
},
|
|
57075
|
+
description: 'OK',
|
|
57076
|
+
},
|
|
57077
|
+
400: { description: 'Bad Request' },
|
|
57078
|
+
401: { description: 'Unauthorized' },
|
|
57079
|
+
},
|
|
57080
|
+
security: [
|
|
57081
|
+
{ api_key: [] },
|
|
57082
|
+
{ client_session: [] },
|
|
57083
|
+
{ pat_with_workspace: [] },
|
|
57084
|
+
{ console_session_with_workspace: [] },
|
|
57085
|
+
],
|
|
57086
|
+
summary: '/user_identities/unmanaged/update',
|
|
57087
|
+
tags: ['/user_identities'],
|
|
57088
|
+
'x-fern-sdk-group-name': ['user_identities', 'unmanaged'],
|
|
57089
|
+
'x-fern-sdk-method-name': 'update',
|
|
57090
|
+
'x-response-key': null,
|
|
57091
|
+
'x-title': 'Update an Unmanaged User Identity',
|
|
57092
|
+
},
|
|
57093
|
+
},
|
|
56777
57094
|
'/user_identities/update': {
|
|
56778
57095
|
patch: {
|
|
56779
57096
|
description: 'Updates a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).',
|