@seamapi/types 1.427.0 → 1.429.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 +816 -438
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +4712 -5979
- package/lib/seam/connect/models/access-grants/access-method.d.ts +3 -3
- package/lib/seam/connect/models/access-grants/access-method.js +2 -2
- package/lib/seam/connect/models/access-grants/access-method.js.map +1 -1
- package/lib/seam/connect/models/action-attempts/action-attempt.d.ts +0 -183
- package/lib/seam/connect/models/action-attempts/action-attempt.js +1 -3
- package/lib/seam/connect/models/action-attempts/action-attempt.js.map +1 -1
- package/lib/seam/connect/openapi.d.ts +1038 -393
- package/lib/seam/connect/openapi.js +746 -292
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +3192 -4921
- package/package.json +1 -1
- package/src/lib/seam/connect/models/access-grants/access-method.ts +2 -2
- package/src/lib/seam/connect/models/action-attempts/action-attempt.ts +1 -3
- package/src/lib/seam/connect/openapi.ts +760 -319
- package/src/lib/seam/connect/route-types.ts +3752 -5656
- package/lib/seam/connect/models/action-attempts/encode-access-method.d.ts +0 -186
- package/lib/seam/connect/models/action-attempts/encode-access-method.js +0 -60
- package/lib/seam/connect/models/action-attempts/encode-access-method.js.map +0 -1
- package/src/lib/seam/connect/models/action-attempts/encode-access-method.ts +0 -101
|
@@ -1698,8 +1698,8 @@ export default {
|
|
|
1698
1698
|
format: 'uri',
|
|
1699
1699
|
type: 'string',
|
|
1700
1700
|
},
|
|
1701
|
-
|
|
1702
|
-
description: 'Indicates whether card
|
|
1701
|
+
is_encoding_required: {
|
|
1702
|
+
description: 'Indicates whether encoding with an card encoder is required to issue or reissue the plastic card associated with the access method.',
|
|
1703
1703
|
type: 'boolean',
|
|
1704
1704
|
},
|
|
1705
1705
|
issued_at: {
|
|
@@ -4817,229 +4817,6 @@ export default {
|
|
|
4817
4817
|
],
|
|
4818
4818
|
type: 'object',
|
|
4819
4819
|
},
|
|
4820
|
-
{
|
|
4821
|
-
description: 'Encoding access method data from the physical encoder onto a card is pending.',
|
|
4822
|
-
properties: {
|
|
4823
|
-
action_attempt_id: {
|
|
4824
|
-
description: 'ID of the action attempt.',
|
|
4825
|
-
format: 'uuid',
|
|
4826
|
-
type: 'string',
|
|
4827
|
-
},
|
|
4828
|
-
action_type: {
|
|
4829
|
-
description: 'Action attempt to track the status of encoding an access method from the physical encoder onto a card.',
|
|
4830
|
-
enum: ['ENCODE_ACCESS_METHOD'],
|
|
4831
|
-
type: 'string',
|
|
4832
|
-
},
|
|
4833
|
-
error: {
|
|
4834
|
-
description: 'Errors associated with the action attempt. Null for pending action attempts.',
|
|
4835
|
-
nullable: true,
|
|
4836
|
-
},
|
|
4837
|
-
result: {
|
|
4838
|
-
description: 'Result of the action attempt. Null for pending action attempts.',
|
|
4839
|
-
nullable: true,
|
|
4840
|
-
},
|
|
4841
|
-
status: { enum: ['pending'], type: 'string' },
|
|
4842
|
-
},
|
|
4843
|
-
required: [
|
|
4844
|
-
'action_attempt_id',
|
|
4845
|
-
'status',
|
|
4846
|
-
'result',
|
|
4847
|
-
'error',
|
|
4848
|
-
'action_type',
|
|
4849
|
-
],
|
|
4850
|
-
type: 'object',
|
|
4851
|
-
},
|
|
4852
|
-
{
|
|
4853
|
-
description: 'Encoding access method data from the physical encoder onto a card succeeded.',
|
|
4854
|
-
properties: {
|
|
4855
|
-
action_attempt_id: {
|
|
4856
|
-
description: 'ID of the action attempt.',
|
|
4857
|
-
format: 'uuid',
|
|
4858
|
-
type: 'string',
|
|
4859
|
-
},
|
|
4860
|
-
action_type: {
|
|
4861
|
-
description: 'Action attempt to track the status of encoding an access method from the physical encoder onto a card.',
|
|
4862
|
-
enum: ['ENCODE_ACCESS_METHOD'],
|
|
4863
|
-
type: 'string',
|
|
4864
|
-
},
|
|
4865
|
-
error: {
|
|
4866
|
-
description: 'Errors associated with the action attempt. Null for successful action attempts.',
|
|
4867
|
-
nullable: true,
|
|
4868
|
-
},
|
|
4869
|
-
result: {
|
|
4870
|
-
description: 'Result of an encoding attempt. If the attempt was successful, includes the access method data that was encoded onto the card.',
|
|
4871
|
-
properties: {
|
|
4872
|
-
access_method_id: {
|
|
4873
|
-
description: 'ID of the access method.',
|
|
4874
|
-
format: 'uuid',
|
|
4875
|
-
type: 'string',
|
|
4876
|
-
},
|
|
4877
|
-
created_at: {
|
|
4878
|
-
description: 'Date and time at which the access method was created.',
|
|
4879
|
-
format: 'date-time',
|
|
4880
|
-
type: 'string',
|
|
4881
|
-
},
|
|
4882
|
-
display_name: {
|
|
4883
|
-
description: 'Display name of the access method.',
|
|
4884
|
-
type: 'string',
|
|
4885
|
-
},
|
|
4886
|
-
instant_key_url: {
|
|
4887
|
-
description: 'URL of the Instant Key for mobile key access methods.',
|
|
4888
|
-
format: 'uri',
|
|
4889
|
-
type: 'string',
|
|
4890
|
-
},
|
|
4891
|
-
is_card_encoding_required: {
|
|
4892
|
-
description: 'Indicates whether card encoding is required for plastic card access methods.',
|
|
4893
|
-
type: 'boolean',
|
|
4894
|
-
},
|
|
4895
|
-
issued_at: {
|
|
4896
|
-
description: 'Date and time at which the access method was issued.',
|
|
4897
|
-
format: 'date-time',
|
|
4898
|
-
type: 'string',
|
|
4899
|
-
},
|
|
4900
|
-
mode: {
|
|
4901
|
-
description: 'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
|
|
4902
|
-
enum: ['code', 'card', 'mobile_key'],
|
|
4903
|
-
type: 'string',
|
|
4904
|
-
},
|
|
4905
|
-
workspace_id: {
|
|
4906
|
-
description: 'ID of the Seam workspace associated with the access method.',
|
|
4907
|
-
format: 'uuid',
|
|
4908
|
-
type: 'string',
|
|
4909
|
-
},
|
|
4910
|
-
},
|
|
4911
|
-
required: [
|
|
4912
|
-
'workspace_id',
|
|
4913
|
-
'access_method_id',
|
|
4914
|
-
'display_name',
|
|
4915
|
-
'mode',
|
|
4916
|
-
'created_at',
|
|
4917
|
-
],
|
|
4918
|
-
type: 'object',
|
|
4919
|
-
},
|
|
4920
|
-
status: { enum: ['success'], type: 'string' },
|
|
4921
|
-
},
|
|
4922
|
-
required: [
|
|
4923
|
-
'action_attempt_id',
|
|
4924
|
-
'status',
|
|
4925
|
-
'error',
|
|
4926
|
-
'action_type',
|
|
4927
|
-
'result',
|
|
4928
|
-
],
|
|
4929
|
-
type: 'object',
|
|
4930
|
-
},
|
|
4931
|
-
{
|
|
4932
|
-
description: 'Encoding access method data from the physical encoder onto a card failed.',
|
|
4933
|
-
properties: {
|
|
4934
|
-
action_attempt_id: {
|
|
4935
|
-
description: 'ID of the action attempt.',
|
|
4936
|
-
format: 'uuid',
|
|
4937
|
-
type: 'string',
|
|
4938
|
-
},
|
|
4939
|
-
action_type: {
|
|
4940
|
-
description: 'Action attempt to track the status of encoding an access method from the physical encoder onto a card.',
|
|
4941
|
-
enum: ['ENCODE_ACCESS_METHOD'],
|
|
4942
|
-
type: 'string',
|
|
4943
|
-
},
|
|
4944
|
-
error: {
|
|
4945
|
-
oneOf: [
|
|
4946
|
-
{
|
|
4947
|
-
description: "Error that doesn't fit into other specific error categories.",
|
|
4948
|
-
properties: {
|
|
4949
|
-
message: {
|
|
4950
|
-
description: 'Message for the error associated with the action attempt.',
|
|
4951
|
-
type: 'string',
|
|
4952
|
-
},
|
|
4953
|
-
type: {
|
|
4954
|
-
description: 'Type of the error associated with the action attempt.',
|
|
4955
|
-
enum: ['uncategorized_error'],
|
|
4956
|
-
type: 'string',
|
|
4957
|
-
},
|
|
4958
|
-
},
|
|
4959
|
-
required: ['type', 'message'],
|
|
4960
|
-
type: 'object',
|
|
4961
|
-
},
|
|
4962
|
-
{
|
|
4963
|
-
description: 'Error to indicate an expired action attempt.',
|
|
4964
|
-
properties: {
|
|
4965
|
-
message: {
|
|
4966
|
-
description: 'Message for the error associated with the action attempt.',
|
|
4967
|
-
type: 'string',
|
|
4968
|
-
},
|
|
4969
|
-
type: {
|
|
4970
|
-
description: 'Type of the error associated with the action attempt.',
|
|
4971
|
-
enum: ['action_attempt_expired'],
|
|
4972
|
-
type: 'string',
|
|
4973
|
-
},
|
|
4974
|
-
},
|
|
4975
|
-
required: ['type', 'message'],
|
|
4976
|
-
type: 'object',
|
|
4977
|
-
},
|
|
4978
|
-
{
|
|
4979
|
-
description: 'Error to indicate that there is no credential on the encoder.',
|
|
4980
|
-
properties: {
|
|
4981
|
-
message: {
|
|
4982
|
-
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
4983
|
-
type: 'string',
|
|
4984
|
-
},
|
|
4985
|
-
type: {
|
|
4986
|
-
description: 'Error type to indicate that there is no credential on the encoder.',
|
|
4987
|
-
enum: ['no_credential_on_encoder'],
|
|
4988
|
-
type: 'string',
|
|
4989
|
-
},
|
|
4990
|
-
},
|
|
4991
|
-
required: ['type', 'message'],
|
|
4992
|
-
type: 'object',
|
|
4993
|
-
},
|
|
4994
|
-
{
|
|
4995
|
-
description: 'Error to indicate an incompatible card format.',
|
|
4996
|
-
properties: {
|
|
4997
|
-
message: {
|
|
4998
|
-
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
4999
|
-
type: 'string',
|
|
5000
|
-
},
|
|
5001
|
-
type: {
|
|
5002
|
-
description: 'Error type to indicate an incompatible card format.',
|
|
5003
|
-
enum: ['incompatible_card_format'],
|
|
5004
|
-
type: 'string',
|
|
5005
|
-
},
|
|
5006
|
-
},
|
|
5007
|
-
required: ['type', 'message'],
|
|
5008
|
-
type: 'object',
|
|
5009
|
-
},
|
|
5010
|
-
{
|
|
5011
|
-
description: 'Error to indicate that the affected credential cannot be reissued.',
|
|
5012
|
-
properties: {
|
|
5013
|
-
message: {
|
|
5014
|
-
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
5015
|
-
type: 'string',
|
|
5016
|
-
},
|
|
5017
|
-
type: {
|
|
5018
|
-
description: 'Error type to indicate that the affected credential cannot be reissued.',
|
|
5019
|
-
enum: ['credential_cannot_be_reissued'],
|
|
5020
|
-
type: 'string',
|
|
5021
|
-
},
|
|
5022
|
-
},
|
|
5023
|
-
required: ['type', 'message'],
|
|
5024
|
-
type: 'object',
|
|
5025
|
-
},
|
|
5026
|
-
],
|
|
5027
|
-
},
|
|
5028
|
-
result: {
|
|
5029
|
-
description: 'Result of the action attempt. Null for failed action attempts.',
|
|
5030
|
-
nullable: true,
|
|
5031
|
-
},
|
|
5032
|
-
status: { enum: ['error'], type: 'string' },
|
|
5033
|
-
},
|
|
5034
|
-
required: [
|
|
5035
|
-
'action_attempt_id',
|
|
5036
|
-
'status',
|
|
5037
|
-
'result',
|
|
5038
|
-
'action_type',
|
|
5039
|
-
'error',
|
|
5040
|
-
],
|
|
5041
|
-
type: 'object',
|
|
5042
|
-
},
|
|
5043
4820
|
{
|
|
5044
4821
|
description: 'Encoding credential data from the physical encoder onto a card is pending.',
|
|
5045
4822
|
properties: {
|
|
@@ -24674,6 +24451,68 @@ export default {
|
|
|
24674
24451
|
'x-title': 'Delete an Access Method',
|
|
24675
24452
|
},
|
|
24676
24453
|
},
|
|
24454
|
+
'/access_methods/encode': {
|
|
24455
|
+
post: {
|
|
24456
|
+
description: 'Encodes an existing [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) onto a plastic card placed on the specified [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).',
|
|
24457
|
+
operationId: 'accessMethodsEncodePost',
|
|
24458
|
+
requestBody: {
|
|
24459
|
+
content: {
|
|
24460
|
+
'application/json': {
|
|
24461
|
+
schema: {
|
|
24462
|
+
properties: {
|
|
24463
|
+
access_method_id: {
|
|
24464
|
+
description: 'ID of the `access_method` to encode onto a card.',
|
|
24465
|
+
format: 'uuid',
|
|
24466
|
+
type: 'string',
|
|
24467
|
+
},
|
|
24468
|
+
acs_encoder_id: {
|
|
24469
|
+
description: 'ID of the `acs_encoder` to use to encode the `acs_credential`.',
|
|
24470
|
+
format: 'uuid',
|
|
24471
|
+
type: 'string',
|
|
24472
|
+
},
|
|
24473
|
+
},
|
|
24474
|
+
required: ['acs_encoder_id', 'access_method_id'],
|
|
24475
|
+
type: 'object',
|
|
24476
|
+
},
|
|
24477
|
+
},
|
|
24478
|
+
},
|
|
24479
|
+
},
|
|
24480
|
+
responses: {
|
|
24481
|
+
200: {
|
|
24482
|
+
content: {
|
|
24483
|
+
'application/json': {
|
|
24484
|
+
schema: {
|
|
24485
|
+
properties: {
|
|
24486
|
+
action_attempt: {
|
|
24487
|
+
$ref: '#/components/schemas/action_attempt',
|
|
24488
|
+
},
|
|
24489
|
+
ok: { type: 'boolean' },
|
|
24490
|
+
},
|
|
24491
|
+
required: ['action_attempt', 'ok'],
|
|
24492
|
+
type: 'object',
|
|
24493
|
+
},
|
|
24494
|
+
},
|
|
24495
|
+
},
|
|
24496
|
+
description: 'OK',
|
|
24497
|
+
},
|
|
24498
|
+
400: { description: 'Bad Request' },
|
|
24499
|
+
401: { description: 'Unauthorized' },
|
|
24500
|
+
},
|
|
24501
|
+
security: [
|
|
24502
|
+
{ pat_with_workspace: [] },
|
|
24503
|
+
{ console_session_with_workspace: [] },
|
|
24504
|
+
{ api_key: [] },
|
|
24505
|
+
],
|
|
24506
|
+
summary: '/access_methods/encode',
|
|
24507
|
+
tags: [],
|
|
24508
|
+
'x-action-attempt-type': 'ENCODE_CREDENTIAL',
|
|
24509
|
+
'x-fern-sdk-group-name': ['access_methods'],
|
|
24510
|
+
'x-fern-sdk-method-name': 'encode',
|
|
24511
|
+
'x-fern-sdk-return-value': 'action_attempt',
|
|
24512
|
+
'x-response-key': 'action_attempt',
|
|
24513
|
+
'x-title': 'Encode an Access Method',
|
|
24514
|
+
},
|
|
24515
|
+
},
|
|
24677
24516
|
'/access_methods/get': {
|
|
24678
24517
|
get: {
|
|
24679
24518
|
description: 'Get an access method.',
|
|
@@ -27356,10 +27195,10 @@ export default {
|
|
|
27356
27195
|
'x-title': 'Update a Credential',
|
|
27357
27196
|
},
|
|
27358
27197
|
},
|
|
27359
|
-
'/acs/encoders/
|
|
27198
|
+
'/acs/encoders/encode_credential': {
|
|
27360
27199
|
post: {
|
|
27361
|
-
description: 'Encodes an existing access
|
|
27362
|
-
operationId: '
|
|
27200
|
+
description: 'Encodes an existing [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) onto a plastic card placed on the specified [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners). Either provide an `acs_credential_id` or an `access_method_id`',
|
|
27201
|
+
operationId: 'acsEncodersEncodeCredentialPost',
|
|
27363
27202
|
requestBody: {
|
|
27364
27203
|
content: {
|
|
27365
27204
|
'application/json': {
|
|
@@ -27370,75 +27209,18 @@ export default {
|
|
|
27370
27209
|
format: 'uuid',
|
|
27371
27210
|
type: 'string',
|
|
27372
27211
|
},
|
|
27212
|
+
acs_credential_id: {
|
|
27213
|
+
description: 'ID of the `acs_credential` to encode onto a card.',
|
|
27214
|
+
format: 'uuid',
|
|
27215
|
+
type: 'string',
|
|
27216
|
+
},
|
|
27373
27217
|
acs_encoder_id: {
|
|
27374
|
-
description: 'ID of the `acs_encoder` to use to encode the `
|
|
27218
|
+
description: 'ID of the `acs_encoder` to use to encode the `acs_credential`.',
|
|
27375
27219
|
format: 'uuid',
|
|
27376
27220
|
type: 'string',
|
|
27377
27221
|
},
|
|
27378
27222
|
},
|
|
27379
|
-
required: ['acs_encoder_id'
|
|
27380
|
-
type: 'object',
|
|
27381
|
-
},
|
|
27382
|
-
},
|
|
27383
|
-
},
|
|
27384
|
-
},
|
|
27385
|
-
responses: {
|
|
27386
|
-
200: {
|
|
27387
|
-
content: {
|
|
27388
|
-
'application/json': {
|
|
27389
|
-
schema: {
|
|
27390
|
-
properties: {
|
|
27391
|
-
action_attempt: {
|
|
27392
|
-
$ref: '#/components/schemas/action_attempt',
|
|
27393
|
-
},
|
|
27394
|
-
ok: { type: 'boolean' },
|
|
27395
|
-
},
|
|
27396
|
-
required: ['action_attempt', 'ok'],
|
|
27397
|
-
type: 'object',
|
|
27398
|
-
},
|
|
27399
|
-
},
|
|
27400
|
-
},
|
|
27401
|
-
description: 'OK',
|
|
27402
|
-
},
|
|
27403
|
-
400: { description: 'Bad Request' },
|
|
27404
|
-
401: { description: 'Unauthorized' },
|
|
27405
|
-
},
|
|
27406
|
-
security: [
|
|
27407
|
-
{ pat_with_workspace: [] },
|
|
27408
|
-
{ console_session_with_workspace: [] },
|
|
27409
|
-
{ api_key: [] },
|
|
27410
|
-
],
|
|
27411
|
-
summary: '/acs/encoders/encode_access_method',
|
|
27412
|
-
tags: ['/acs'],
|
|
27413
|
-
'x-action-attempt-type': 'ENCODE_ACCESS_METHOD',
|
|
27414
|
-
'x-fern-sdk-group-name': ['acs', 'encoders'],
|
|
27415
|
-
'x-fern-sdk-method-name': 'encode_access_method',
|
|
27416
|
-
'x-fern-sdk-return-value': 'action_attempt',
|
|
27417
|
-
'x-response-key': 'action_attempt',
|
|
27418
|
-
'x-title': 'Encode an Access Method',
|
|
27419
|
-
},
|
|
27420
|
-
},
|
|
27421
|
-
'/acs/encoders/encode_credential': {
|
|
27422
|
-
post: {
|
|
27423
|
-
description: 'Encodes an existing [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) onto a plastic card placed on the specified [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).',
|
|
27424
|
-
operationId: 'acsEncodersEncodeCredentialPost',
|
|
27425
|
-
requestBody: {
|
|
27426
|
-
content: {
|
|
27427
|
-
'application/json': {
|
|
27428
|
-
schema: {
|
|
27429
|
-
properties: {
|
|
27430
|
-
acs_credential_id: {
|
|
27431
|
-
description: 'ID of the `acs_credential` to encode onto a card.',
|
|
27432
|
-
format: 'uuid',
|
|
27433
|
-
type: 'string',
|
|
27434
|
-
},
|
|
27435
|
-
acs_encoder_id: {
|
|
27436
|
-
description: 'ID of the `acs_encoder` to use to encode the `acs_credential`.',
|
|
27437
|
-
format: 'uuid',
|
|
27438
|
-
type: 'string',
|
|
27439
|
-
},
|
|
27440
|
-
},
|
|
27441
|
-
required: ['acs_encoder_id', 'acs_credential_id'],
|
|
27223
|
+
required: ['acs_encoder_id'],
|
|
27442
27224
|
type: 'object',
|
|
27443
27225
|
},
|
|
27444
27226
|
},
|
|
@@ -40465,6 +40247,678 @@ export default {
|
|
|
40465
40247
|
'x-undocumented': 'Seam Bridge Client only.',
|
|
40466
40248
|
},
|
|
40467
40249
|
},
|
|
40250
|
+
'/seam/customer/v1/automation_runs/list': {
|
|
40251
|
+
get: {
|
|
40252
|
+
description: 'Returns a list of all automation runs for a workspace or customer.',
|
|
40253
|
+
operationId: 'seamCustomerV1AutomationRunsListGet',
|
|
40254
|
+
parameters: [
|
|
40255
|
+
{
|
|
40256
|
+
in: 'query',
|
|
40257
|
+
name: 'automation_id',
|
|
40258
|
+
schema: {
|
|
40259
|
+
description: 'ID of the automation for which you want to retrieve all automation runs.',
|
|
40260
|
+
format: 'uuid',
|
|
40261
|
+
type: 'string',
|
|
40262
|
+
},
|
|
40263
|
+
},
|
|
40264
|
+
{
|
|
40265
|
+
in: 'query',
|
|
40266
|
+
name: 'partner_resource_id',
|
|
40267
|
+
schema: {
|
|
40268
|
+
description: 'ID of the partner resource for which you want to retrieve all automation runs.',
|
|
40269
|
+
format: 'uuid',
|
|
40270
|
+
type: 'string',
|
|
40271
|
+
},
|
|
40272
|
+
},
|
|
40273
|
+
{
|
|
40274
|
+
in: 'query',
|
|
40275
|
+
name: 'rule',
|
|
40276
|
+
schema: {
|
|
40277
|
+
description: 'Filter automation runs by the specific rule that was executed.',
|
|
40278
|
+
enum: [
|
|
40279
|
+
'reservation_created',
|
|
40280
|
+
'reservation_time_updated',
|
|
40281
|
+
'reservation_deleted',
|
|
40282
|
+
],
|
|
40283
|
+
type: 'string',
|
|
40284
|
+
},
|
|
40285
|
+
},
|
|
40286
|
+
{
|
|
40287
|
+
in: 'query',
|
|
40288
|
+
name: 'success',
|
|
40289
|
+
schema: {
|
|
40290
|
+
description: 'Filter automation runs by success status.',
|
|
40291
|
+
type: 'boolean',
|
|
40292
|
+
},
|
|
40293
|
+
},
|
|
40294
|
+
{
|
|
40295
|
+
in: 'query',
|
|
40296
|
+
name: 'limit',
|
|
40297
|
+
schema: {
|
|
40298
|
+
default: 500,
|
|
40299
|
+
description: 'Maximum number of records to return per page.',
|
|
40300
|
+
exclusiveMinimum: true,
|
|
40301
|
+
minimum: 0,
|
|
40302
|
+
type: 'integer',
|
|
40303
|
+
},
|
|
40304
|
+
},
|
|
40305
|
+
{
|
|
40306
|
+
in: 'query',
|
|
40307
|
+
name: 'created_before',
|
|
40308
|
+
schema: {
|
|
40309
|
+
description: 'Timestamp by which to limit returned automation runs. Returns runs created before this timestamp.',
|
|
40310
|
+
format: 'date-time',
|
|
40311
|
+
type: 'string',
|
|
40312
|
+
},
|
|
40313
|
+
},
|
|
40314
|
+
{
|
|
40315
|
+
in: 'query',
|
|
40316
|
+
name: 'page_cursor',
|
|
40317
|
+
schema: {
|
|
40318
|
+
description: "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
|
|
40319
|
+
nullable: true,
|
|
40320
|
+
type: 'string',
|
|
40321
|
+
},
|
|
40322
|
+
},
|
|
40323
|
+
],
|
|
40324
|
+
responses: {
|
|
40325
|
+
200: {
|
|
40326
|
+
content: {
|
|
40327
|
+
'application/json': {
|
|
40328
|
+
schema: {
|
|
40329
|
+
properties: {
|
|
40330
|
+
automation_runs: {
|
|
40331
|
+
items: {
|
|
40332
|
+
properties: {
|
|
40333
|
+
automation_id: { format: 'uuid', type: 'string' },
|
|
40334
|
+
automation_result: {
|
|
40335
|
+
properties: {
|
|
40336
|
+
actions: {
|
|
40337
|
+
items: {
|
|
40338
|
+
properties: {
|
|
40339
|
+
access_grant_id: {
|
|
40340
|
+
format: 'uuid',
|
|
40341
|
+
type: 'string',
|
|
40342
|
+
},
|
|
40343
|
+
action_type: {
|
|
40344
|
+
enum: ['create', 'update', 'delete'],
|
|
40345
|
+
type: 'string',
|
|
40346
|
+
},
|
|
40347
|
+
resource_type: { type: 'string' },
|
|
40348
|
+
},
|
|
40349
|
+
required: [
|
|
40350
|
+
'action_type',
|
|
40351
|
+
'resource_type',
|
|
40352
|
+
'access_grant_id',
|
|
40353
|
+
],
|
|
40354
|
+
type: 'object',
|
|
40355
|
+
},
|
|
40356
|
+
type: 'array',
|
|
40357
|
+
},
|
|
40358
|
+
error: { type: 'string' },
|
|
40359
|
+
rule: {
|
|
40360
|
+
enum: [
|
|
40361
|
+
'reservation_created',
|
|
40362
|
+
'reservation_time_updated',
|
|
40363
|
+
'reservation_deleted',
|
|
40364
|
+
],
|
|
40365
|
+
type: 'string',
|
|
40366
|
+
},
|
|
40367
|
+
success: { type: 'boolean' },
|
|
40368
|
+
},
|
|
40369
|
+
required: ['success', 'rule', 'actions'],
|
|
40370
|
+
type: 'object',
|
|
40371
|
+
},
|
|
40372
|
+
automation_run_id: { format: 'uuid', type: 'string' },
|
|
40373
|
+
created_at: { type: 'string' },
|
|
40374
|
+
partner_resource_id: {
|
|
40375
|
+
format: 'uuid',
|
|
40376
|
+
type: 'string',
|
|
40377
|
+
},
|
|
40378
|
+
workspace_id: { format: 'uuid', type: 'string' },
|
|
40379
|
+
},
|
|
40380
|
+
required: [
|
|
40381
|
+
'automation_run_id',
|
|
40382
|
+
'workspace_id',
|
|
40383
|
+
'automation_id',
|
|
40384
|
+
'partner_resource_id',
|
|
40385
|
+
'created_at',
|
|
40386
|
+
],
|
|
40387
|
+
type: 'object',
|
|
40388
|
+
},
|
|
40389
|
+
type: 'array',
|
|
40390
|
+
},
|
|
40391
|
+
ok: { type: 'boolean' },
|
|
40392
|
+
pagination: { $ref: '#/components/schemas/pagination' },
|
|
40393
|
+
},
|
|
40394
|
+
required: ['automation_runs', 'pagination', 'ok'],
|
|
40395
|
+
type: 'object',
|
|
40396
|
+
},
|
|
40397
|
+
},
|
|
40398
|
+
},
|
|
40399
|
+
description: 'OK',
|
|
40400
|
+
},
|
|
40401
|
+
400: { description: 'Bad Request' },
|
|
40402
|
+
401: { description: 'Unauthorized' },
|
|
40403
|
+
},
|
|
40404
|
+
security: [
|
|
40405
|
+
{ console_session_with_workspace: [] },
|
|
40406
|
+
{ api_key: [] },
|
|
40407
|
+
{ client_session_with_customer: [] },
|
|
40408
|
+
],
|
|
40409
|
+
summary: '/seam/customer/v1/automation_runs/list',
|
|
40410
|
+
tags: [],
|
|
40411
|
+
'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'automation_runs'],
|
|
40412
|
+
'x-fern-sdk-method-name': 'list',
|
|
40413
|
+
'x-fern-sdk-return-value': 'automation_runs',
|
|
40414
|
+
'x-response-key': 'automation_runs',
|
|
40415
|
+
'x-title': 'List Automation Runs',
|
|
40416
|
+
'x-undocumented': 'Internal endpoint for customer portals.',
|
|
40417
|
+
},
|
|
40418
|
+
post: {
|
|
40419
|
+
description: 'Returns a list of all automation runs for a workspace or customer.',
|
|
40420
|
+
operationId: 'seamCustomerV1AutomationRunsListPost',
|
|
40421
|
+
requestBody: {
|
|
40422
|
+
content: {
|
|
40423
|
+
'application/json': {
|
|
40424
|
+
schema: {
|
|
40425
|
+
properties: {
|
|
40426
|
+
automation_id: {
|
|
40427
|
+
description: 'ID of the automation for which you want to retrieve all automation runs.',
|
|
40428
|
+
format: 'uuid',
|
|
40429
|
+
type: 'string',
|
|
40430
|
+
},
|
|
40431
|
+
created_before: {
|
|
40432
|
+
description: 'Timestamp by which to limit returned automation runs. Returns runs created before this timestamp.',
|
|
40433
|
+
format: 'date-time',
|
|
40434
|
+
type: 'string',
|
|
40435
|
+
},
|
|
40436
|
+
limit: {
|
|
40437
|
+
default: 500,
|
|
40438
|
+
description: 'Maximum number of records to return per page.',
|
|
40439
|
+
exclusiveMinimum: true,
|
|
40440
|
+
minimum: 0,
|
|
40441
|
+
type: 'integer',
|
|
40442
|
+
},
|
|
40443
|
+
page_cursor: {
|
|
40444
|
+
description: "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
|
|
40445
|
+
nullable: true,
|
|
40446
|
+
type: 'string',
|
|
40447
|
+
},
|
|
40448
|
+
partner_resource_id: {
|
|
40449
|
+
description: 'ID of the partner resource for which you want to retrieve all automation runs.',
|
|
40450
|
+
format: 'uuid',
|
|
40451
|
+
type: 'string',
|
|
40452
|
+
},
|
|
40453
|
+
rule: {
|
|
40454
|
+
description: 'Filter automation runs by the specific rule that was executed.',
|
|
40455
|
+
enum: [
|
|
40456
|
+
'reservation_created',
|
|
40457
|
+
'reservation_time_updated',
|
|
40458
|
+
'reservation_deleted',
|
|
40459
|
+
],
|
|
40460
|
+
type: 'string',
|
|
40461
|
+
},
|
|
40462
|
+
success: {
|
|
40463
|
+
description: 'Filter automation runs by success status.',
|
|
40464
|
+
type: 'boolean',
|
|
40465
|
+
},
|
|
40466
|
+
},
|
|
40467
|
+
type: 'object',
|
|
40468
|
+
},
|
|
40469
|
+
},
|
|
40470
|
+
},
|
|
40471
|
+
},
|
|
40472
|
+
responses: {
|
|
40473
|
+
200: {
|
|
40474
|
+
content: {
|
|
40475
|
+
'application/json': {
|
|
40476
|
+
schema: {
|
|
40477
|
+
properties: {
|
|
40478
|
+
automation_runs: {
|
|
40479
|
+
items: {
|
|
40480
|
+
properties: {
|
|
40481
|
+
automation_id: { format: 'uuid', type: 'string' },
|
|
40482
|
+
automation_result: {
|
|
40483
|
+
properties: {
|
|
40484
|
+
actions: {
|
|
40485
|
+
items: {
|
|
40486
|
+
properties: {
|
|
40487
|
+
access_grant_id: {
|
|
40488
|
+
format: 'uuid',
|
|
40489
|
+
type: 'string',
|
|
40490
|
+
},
|
|
40491
|
+
action_type: {
|
|
40492
|
+
enum: ['create', 'update', 'delete'],
|
|
40493
|
+
type: 'string',
|
|
40494
|
+
},
|
|
40495
|
+
resource_type: { type: 'string' },
|
|
40496
|
+
},
|
|
40497
|
+
required: [
|
|
40498
|
+
'action_type',
|
|
40499
|
+
'resource_type',
|
|
40500
|
+
'access_grant_id',
|
|
40501
|
+
],
|
|
40502
|
+
type: 'object',
|
|
40503
|
+
},
|
|
40504
|
+
type: 'array',
|
|
40505
|
+
},
|
|
40506
|
+
error: { type: 'string' },
|
|
40507
|
+
rule: {
|
|
40508
|
+
enum: [
|
|
40509
|
+
'reservation_created',
|
|
40510
|
+
'reservation_time_updated',
|
|
40511
|
+
'reservation_deleted',
|
|
40512
|
+
],
|
|
40513
|
+
type: 'string',
|
|
40514
|
+
},
|
|
40515
|
+
success: { type: 'boolean' },
|
|
40516
|
+
},
|
|
40517
|
+
required: ['success', 'rule', 'actions'],
|
|
40518
|
+
type: 'object',
|
|
40519
|
+
},
|
|
40520
|
+
automation_run_id: { format: 'uuid', type: 'string' },
|
|
40521
|
+
created_at: { type: 'string' },
|
|
40522
|
+
partner_resource_id: {
|
|
40523
|
+
format: 'uuid',
|
|
40524
|
+
type: 'string',
|
|
40525
|
+
},
|
|
40526
|
+
workspace_id: { format: 'uuid', type: 'string' },
|
|
40527
|
+
},
|
|
40528
|
+
required: [
|
|
40529
|
+
'automation_run_id',
|
|
40530
|
+
'workspace_id',
|
|
40531
|
+
'automation_id',
|
|
40532
|
+
'partner_resource_id',
|
|
40533
|
+
'created_at',
|
|
40534
|
+
],
|
|
40535
|
+
type: 'object',
|
|
40536
|
+
},
|
|
40537
|
+
type: 'array',
|
|
40538
|
+
},
|
|
40539
|
+
ok: { type: 'boolean' },
|
|
40540
|
+
pagination: { $ref: '#/components/schemas/pagination' },
|
|
40541
|
+
},
|
|
40542
|
+
required: ['automation_runs', 'pagination', 'ok'],
|
|
40543
|
+
type: 'object',
|
|
40544
|
+
},
|
|
40545
|
+
},
|
|
40546
|
+
},
|
|
40547
|
+
description: 'OK',
|
|
40548
|
+
},
|
|
40549
|
+
400: { description: 'Bad Request' },
|
|
40550
|
+
401: { description: 'Unauthorized' },
|
|
40551
|
+
},
|
|
40552
|
+
security: [
|
|
40553
|
+
{ console_session_with_workspace: [] },
|
|
40554
|
+
{ api_key: [] },
|
|
40555
|
+
{ client_session_with_customer: [] },
|
|
40556
|
+
],
|
|
40557
|
+
summary: '/seam/customer/v1/automation_runs/list',
|
|
40558
|
+
tags: [],
|
|
40559
|
+
'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'automation_runs'],
|
|
40560
|
+
'x-fern-sdk-method-name': 'list',
|
|
40561
|
+
'x-fern-sdk-return-value': 'automation_runs',
|
|
40562
|
+
'x-response-key': 'automation_runs',
|
|
40563
|
+
'x-title': 'List Automation Runs',
|
|
40564
|
+
'x-undocumented': 'Internal endpoint for customer portals.',
|
|
40565
|
+
},
|
|
40566
|
+
},
|
|
40567
|
+
'/seam/customer/v1/automations/delete': {
|
|
40568
|
+
delete: {
|
|
40569
|
+
description: 'Deletes the automation configuration for a customer portal workspace.\nSupports both console session and customer client session authentication.',
|
|
40570
|
+
operationId: 'seamCustomerV1AutomationsDeleteDelete',
|
|
40571
|
+
requestBody: {
|
|
40572
|
+
content: {
|
|
40573
|
+
'application/json': { schema: { properties: {}, type: 'object' } },
|
|
40574
|
+
},
|
|
40575
|
+
},
|
|
40576
|
+
responses: {
|
|
40577
|
+
200: {
|
|
40578
|
+
content: {
|
|
40579
|
+
'application/json': {
|
|
40580
|
+
schema: {
|
|
40581
|
+
properties: { ok: { type: 'boolean' } },
|
|
40582
|
+
required: ['ok'],
|
|
40583
|
+
type: 'object',
|
|
40584
|
+
},
|
|
40585
|
+
},
|
|
40586
|
+
},
|
|
40587
|
+
description: 'OK',
|
|
40588
|
+
},
|
|
40589
|
+
400: { description: 'Bad Request' },
|
|
40590
|
+
401: { description: 'Unauthorized' },
|
|
40591
|
+
},
|
|
40592
|
+
security: [
|
|
40593
|
+
{ console_session_with_workspace: [] },
|
|
40594
|
+
{ api_key: [] },
|
|
40595
|
+
{ client_session_with_customer: [] },
|
|
40596
|
+
],
|
|
40597
|
+
summary: '/seam/customer/v1/automations/delete',
|
|
40598
|
+
tags: [],
|
|
40599
|
+
'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'automations'],
|
|
40600
|
+
'x-fern-sdk-method-name': 'delete',
|
|
40601
|
+
'x-response-key': null,
|
|
40602
|
+
'x-title': 'Delete Customer Portal Automation Configuration',
|
|
40603
|
+
'x-undocumented': 'Internal endpoint for customer portals.',
|
|
40604
|
+
},
|
|
40605
|
+
},
|
|
40606
|
+
'/seam/customer/v1/automations/get': {
|
|
40607
|
+
get: {
|
|
40608
|
+
description: 'Gets the current automation configuration for a customer portal workspace.\nFor customer client sessions, returns customer-specific config if available,\notherwise falls back to workspace-level config.',
|
|
40609
|
+
operationId: 'seamCustomerV1AutomationsGetGet',
|
|
40610
|
+
responses: {
|
|
40611
|
+
200: {
|
|
40612
|
+
content: {
|
|
40613
|
+
'application/json': {
|
|
40614
|
+
schema: {
|
|
40615
|
+
properties: {
|
|
40616
|
+
access_rules: {
|
|
40617
|
+
properties: {
|
|
40618
|
+
reservation_created: {
|
|
40619
|
+
properties: {
|
|
40620
|
+
config: {
|
|
40621
|
+
properties: {
|
|
40622
|
+
access_methods: {
|
|
40623
|
+
items: {
|
|
40624
|
+
enum: ['card', 'mobile_key', 'code'],
|
|
40625
|
+
type: 'string',
|
|
40626
|
+
},
|
|
40627
|
+
minItems: 1,
|
|
40628
|
+
type: 'array',
|
|
40629
|
+
},
|
|
40630
|
+
method_issuance_strategy: {
|
|
40631
|
+
enum: [
|
|
40632
|
+
'first_available',
|
|
40633
|
+
'first_two_available',
|
|
40634
|
+
'all_available',
|
|
40635
|
+
],
|
|
40636
|
+
type: 'string',
|
|
40637
|
+
},
|
|
40638
|
+
},
|
|
40639
|
+
required: [
|
|
40640
|
+
'access_methods',
|
|
40641
|
+
'method_issuance_strategy',
|
|
40642
|
+
],
|
|
40643
|
+
type: 'object',
|
|
40644
|
+
},
|
|
40645
|
+
rule: {
|
|
40646
|
+
enum: ['reservation_created'],
|
|
40647
|
+
type: 'string',
|
|
40648
|
+
},
|
|
40649
|
+
},
|
|
40650
|
+
required: ['rule', 'config'],
|
|
40651
|
+
type: 'object',
|
|
40652
|
+
},
|
|
40653
|
+
reservation_deleted: {
|
|
40654
|
+
properties: {
|
|
40655
|
+
config: {
|
|
40656
|
+
$ref: '#/components/schemas/access_code',
|
|
40657
|
+
},
|
|
40658
|
+
rule: {
|
|
40659
|
+
enum: ['reservation_deleted'],
|
|
40660
|
+
type: 'string',
|
|
40661
|
+
},
|
|
40662
|
+
},
|
|
40663
|
+
required: ['rule', 'config'],
|
|
40664
|
+
type: 'object',
|
|
40665
|
+
},
|
|
40666
|
+
reservation_time_updated: {
|
|
40667
|
+
properties: {
|
|
40668
|
+
config: {
|
|
40669
|
+
$ref: '#/components/schemas/access_code',
|
|
40670
|
+
},
|
|
40671
|
+
rule: {
|
|
40672
|
+
enum: ['reservation_time_updated'],
|
|
40673
|
+
type: 'string',
|
|
40674
|
+
},
|
|
40675
|
+
},
|
|
40676
|
+
required: ['rule', 'config'],
|
|
40677
|
+
type: 'object',
|
|
40678
|
+
},
|
|
40679
|
+
},
|
|
40680
|
+
type: 'object',
|
|
40681
|
+
},
|
|
40682
|
+
ok: { type: 'boolean' },
|
|
40683
|
+
},
|
|
40684
|
+
required: ['ok'],
|
|
40685
|
+
type: 'object',
|
|
40686
|
+
},
|
|
40687
|
+
},
|
|
40688
|
+
},
|
|
40689
|
+
description: 'OK',
|
|
40690
|
+
},
|
|
40691
|
+
400: { description: 'Bad Request' },
|
|
40692
|
+
401: { description: 'Unauthorized' },
|
|
40693
|
+
},
|
|
40694
|
+
security: [
|
|
40695
|
+
{ console_session_with_workspace: [] },
|
|
40696
|
+
{ api_key: [] },
|
|
40697
|
+
{ client_session_with_customer: [] },
|
|
40698
|
+
],
|
|
40699
|
+
summary: '/seam/customer/v1/automations/get',
|
|
40700
|
+
tags: [],
|
|
40701
|
+
'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'automations'],
|
|
40702
|
+
'x-fern-sdk-method-name': 'get',
|
|
40703
|
+
'x-response-key': null,
|
|
40704
|
+
'x-title': 'Get Customer Portal Automation Configuration',
|
|
40705
|
+
'x-undocumented': 'Internal endpoint for customer portals.',
|
|
40706
|
+
},
|
|
40707
|
+
},
|
|
40708
|
+
'/seam/customer/v1/automations/update': {
|
|
40709
|
+
patch: {
|
|
40710
|
+
description: 'Updates the automation configuration for a customer portal workspace.\nSupports both console session and customer client session authentication.',
|
|
40711
|
+
operationId: 'seamCustomerV1AutomationsUpdatePatch',
|
|
40712
|
+
requestBody: {
|
|
40713
|
+
content: {
|
|
40714
|
+
'application/json': {
|
|
40715
|
+
schema: {
|
|
40716
|
+
properties: {
|
|
40717
|
+
access_rules: {
|
|
40718
|
+
description: 'Access automation rules configuration.',
|
|
40719
|
+
properties: {
|
|
40720
|
+
reservation_created: {
|
|
40721
|
+
properties: {
|
|
40722
|
+
config: {
|
|
40723
|
+
properties: {
|
|
40724
|
+
access_methods: {
|
|
40725
|
+
items: {
|
|
40726
|
+
enum: ['card', 'mobile_key', 'code'],
|
|
40727
|
+
type: 'string',
|
|
40728
|
+
},
|
|
40729
|
+
minItems: 1,
|
|
40730
|
+
type: 'array',
|
|
40731
|
+
},
|
|
40732
|
+
method_issuance_strategy: {
|
|
40733
|
+
enum: [
|
|
40734
|
+
'first_available',
|
|
40735
|
+
'first_two_available',
|
|
40736
|
+
'all_available',
|
|
40737
|
+
],
|
|
40738
|
+
type: 'string',
|
|
40739
|
+
},
|
|
40740
|
+
},
|
|
40741
|
+
required: [
|
|
40742
|
+
'access_methods',
|
|
40743
|
+
'method_issuance_strategy',
|
|
40744
|
+
],
|
|
40745
|
+
type: 'object',
|
|
40746
|
+
},
|
|
40747
|
+
rule: {
|
|
40748
|
+
enum: ['reservation_created'],
|
|
40749
|
+
type: 'string',
|
|
40750
|
+
},
|
|
40751
|
+
},
|
|
40752
|
+
required: ['rule', 'config'],
|
|
40753
|
+
type: 'object',
|
|
40754
|
+
},
|
|
40755
|
+
reservation_deleted: {
|
|
40756
|
+
properties: {
|
|
40757
|
+
config: { properties: {}, type: 'object' },
|
|
40758
|
+
rule: {
|
|
40759
|
+
enum: ['reservation_deleted'],
|
|
40760
|
+
type: 'string',
|
|
40761
|
+
},
|
|
40762
|
+
},
|
|
40763
|
+
required: ['rule', 'config'],
|
|
40764
|
+
type: 'object',
|
|
40765
|
+
},
|
|
40766
|
+
reservation_time_updated: {
|
|
40767
|
+
properties: {
|
|
40768
|
+
config: { properties: {}, type: 'object' },
|
|
40769
|
+
rule: {
|
|
40770
|
+
enum: ['reservation_time_updated'],
|
|
40771
|
+
type: 'string',
|
|
40772
|
+
},
|
|
40773
|
+
},
|
|
40774
|
+
required: ['rule', 'config'],
|
|
40775
|
+
type: 'object',
|
|
40776
|
+
},
|
|
40777
|
+
},
|
|
40778
|
+
type: 'object',
|
|
40779
|
+
},
|
|
40780
|
+
},
|
|
40781
|
+
type: 'object',
|
|
40782
|
+
},
|
|
40783
|
+
},
|
|
40784
|
+
},
|
|
40785
|
+
},
|
|
40786
|
+
responses: {
|
|
40787
|
+
200: {
|
|
40788
|
+
content: {
|
|
40789
|
+
'application/json': {
|
|
40790
|
+
schema: {
|
|
40791
|
+
properties: { ok: { type: 'boolean' } },
|
|
40792
|
+
required: ['ok'],
|
|
40793
|
+
type: 'object',
|
|
40794
|
+
},
|
|
40795
|
+
},
|
|
40796
|
+
},
|
|
40797
|
+
description: 'OK',
|
|
40798
|
+
},
|
|
40799
|
+
400: { description: 'Bad Request' },
|
|
40800
|
+
401: { description: 'Unauthorized' },
|
|
40801
|
+
},
|
|
40802
|
+
security: [
|
|
40803
|
+
{ console_session_with_workspace: [] },
|
|
40804
|
+
{ api_key: [] },
|
|
40805
|
+
{ client_session_with_customer: [] },
|
|
40806
|
+
],
|
|
40807
|
+
summary: '/seam/customer/v1/automations/update',
|
|
40808
|
+
tags: [],
|
|
40809
|
+
'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'automations'],
|
|
40810
|
+
'x-fern-sdk-method-name': 'update',
|
|
40811
|
+
'x-response-key': null,
|
|
40812
|
+
'x-title': 'Update Customer Portal Automation Configuration',
|
|
40813
|
+
'x-undocumented': 'Internal endpoint for customer portals.',
|
|
40814
|
+
},
|
|
40815
|
+
post: {
|
|
40816
|
+
description: 'Updates the automation configuration for a customer portal workspace.\nSupports both console session and customer client session authentication.',
|
|
40817
|
+
operationId: 'seamCustomerV1AutomationsUpdatePost',
|
|
40818
|
+
requestBody: {
|
|
40819
|
+
content: {
|
|
40820
|
+
'application/json': {
|
|
40821
|
+
schema: {
|
|
40822
|
+
properties: {
|
|
40823
|
+
access_rules: {
|
|
40824
|
+
description: 'Access automation rules configuration.',
|
|
40825
|
+
properties: {
|
|
40826
|
+
reservation_created: {
|
|
40827
|
+
properties: {
|
|
40828
|
+
config: {
|
|
40829
|
+
properties: {
|
|
40830
|
+
access_methods: {
|
|
40831
|
+
items: {
|
|
40832
|
+
enum: ['card', 'mobile_key', 'code'],
|
|
40833
|
+
type: 'string',
|
|
40834
|
+
},
|
|
40835
|
+
minItems: 1,
|
|
40836
|
+
type: 'array',
|
|
40837
|
+
},
|
|
40838
|
+
method_issuance_strategy: {
|
|
40839
|
+
enum: [
|
|
40840
|
+
'first_available',
|
|
40841
|
+
'first_two_available',
|
|
40842
|
+
'all_available',
|
|
40843
|
+
],
|
|
40844
|
+
type: 'string',
|
|
40845
|
+
},
|
|
40846
|
+
},
|
|
40847
|
+
required: [
|
|
40848
|
+
'access_methods',
|
|
40849
|
+
'method_issuance_strategy',
|
|
40850
|
+
],
|
|
40851
|
+
type: 'object',
|
|
40852
|
+
},
|
|
40853
|
+
rule: {
|
|
40854
|
+
enum: ['reservation_created'],
|
|
40855
|
+
type: 'string',
|
|
40856
|
+
},
|
|
40857
|
+
},
|
|
40858
|
+
required: ['rule', 'config'],
|
|
40859
|
+
type: 'object',
|
|
40860
|
+
},
|
|
40861
|
+
reservation_deleted: {
|
|
40862
|
+
properties: {
|
|
40863
|
+
config: { properties: {}, type: 'object' },
|
|
40864
|
+
rule: {
|
|
40865
|
+
enum: ['reservation_deleted'],
|
|
40866
|
+
type: 'string',
|
|
40867
|
+
},
|
|
40868
|
+
},
|
|
40869
|
+
required: ['rule', 'config'],
|
|
40870
|
+
type: 'object',
|
|
40871
|
+
},
|
|
40872
|
+
reservation_time_updated: {
|
|
40873
|
+
properties: {
|
|
40874
|
+
config: { properties: {}, type: 'object' },
|
|
40875
|
+
rule: {
|
|
40876
|
+
enum: ['reservation_time_updated'],
|
|
40877
|
+
type: 'string',
|
|
40878
|
+
},
|
|
40879
|
+
},
|
|
40880
|
+
required: ['rule', 'config'],
|
|
40881
|
+
type: 'object',
|
|
40882
|
+
},
|
|
40883
|
+
},
|
|
40884
|
+
type: 'object',
|
|
40885
|
+
},
|
|
40886
|
+
},
|
|
40887
|
+
type: 'object',
|
|
40888
|
+
},
|
|
40889
|
+
},
|
|
40890
|
+
},
|
|
40891
|
+
},
|
|
40892
|
+
responses: {
|
|
40893
|
+
200: {
|
|
40894
|
+
content: {
|
|
40895
|
+
'application/json': {
|
|
40896
|
+
schema: {
|
|
40897
|
+
properties: { ok: { type: 'boolean' } },
|
|
40898
|
+
required: ['ok'],
|
|
40899
|
+
type: 'object',
|
|
40900
|
+
},
|
|
40901
|
+
},
|
|
40902
|
+
},
|
|
40903
|
+
description: 'OK',
|
|
40904
|
+
},
|
|
40905
|
+
400: { description: 'Bad Request' },
|
|
40906
|
+
401: { description: 'Unauthorized' },
|
|
40907
|
+
},
|
|
40908
|
+
security: [
|
|
40909
|
+
{ console_session_with_workspace: [] },
|
|
40910
|
+
{ api_key: [] },
|
|
40911
|
+
{ client_session_with_customer: [] },
|
|
40912
|
+
],
|
|
40913
|
+
summary: '/seam/customer/v1/automations/update',
|
|
40914
|
+
tags: [],
|
|
40915
|
+
'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'automations'],
|
|
40916
|
+
'x-fern-sdk-method-name': 'update',
|
|
40917
|
+
'x-response-key': null,
|
|
40918
|
+
'x-title': 'Update Customer Portal Automation Configuration',
|
|
40919
|
+
'x-undocumented': 'Internal endpoint for customer portals.',
|
|
40920
|
+
},
|
|
40921
|
+
},
|
|
40468
40922
|
'/seam/customer/v1/portals/get': {
|
|
40469
40923
|
get: {
|
|
40470
40924
|
description: 'Retrieves the configuration for a customer portal identified by customer_portal_id.',
|