@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
|
@@ -1956,9 +1956,9 @@ export default {
|
|
|
1956
1956
|
format: 'uri',
|
|
1957
1957
|
type: 'string',
|
|
1958
1958
|
},
|
|
1959
|
-
|
|
1959
|
+
is_encoding_required: {
|
|
1960
1960
|
description:
|
|
1961
|
-
'Indicates whether card
|
|
1961
|
+
'Indicates whether encoding with an card encoder is required to issue or reissue the plastic card associated with the access method.',
|
|
1962
1962
|
type: 'boolean',
|
|
1963
1963
|
},
|
|
1964
1964
|
issued_at: {
|
|
@@ -5513,260 +5513,6 @@ export default {
|
|
|
5513
5513
|
],
|
|
5514
5514
|
type: 'object',
|
|
5515
5515
|
},
|
|
5516
|
-
{
|
|
5517
|
-
description:
|
|
5518
|
-
'Encoding access method data from the physical encoder onto a card is pending.',
|
|
5519
|
-
properties: {
|
|
5520
|
-
action_attempt_id: {
|
|
5521
|
-
description: 'ID of the action attempt.',
|
|
5522
|
-
format: 'uuid',
|
|
5523
|
-
type: 'string',
|
|
5524
|
-
},
|
|
5525
|
-
action_type: {
|
|
5526
|
-
description:
|
|
5527
|
-
'Action attempt to track the status of encoding an access method from the physical encoder onto a card.',
|
|
5528
|
-
enum: ['ENCODE_ACCESS_METHOD'],
|
|
5529
|
-
type: 'string',
|
|
5530
|
-
},
|
|
5531
|
-
error: {
|
|
5532
|
-
description:
|
|
5533
|
-
'Errors associated with the action attempt. Null for pending action attempts.',
|
|
5534
|
-
nullable: true,
|
|
5535
|
-
},
|
|
5536
|
-
result: {
|
|
5537
|
-
description:
|
|
5538
|
-
'Result of the action attempt. Null for pending action attempts.',
|
|
5539
|
-
nullable: true,
|
|
5540
|
-
},
|
|
5541
|
-
status: { enum: ['pending'], type: 'string' },
|
|
5542
|
-
},
|
|
5543
|
-
required: [
|
|
5544
|
-
'action_attempt_id',
|
|
5545
|
-
'status',
|
|
5546
|
-
'result',
|
|
5547
|
-
'error',
|
|
5548
|
-
'action_type',
|
|
5549
|
-
],
|
|
5550
|
-
type: 'object',
|
|
5551
|
-
},
|
|
5552
|
-
{
|
|
5553
|
-
description:
|
|
5554
|
-
'Encoding access method data from the physical encoder onto a card succeeded.',
|
|
5555
|
-
properties: {
|
|
5556
|
-
action_attempt_id: {
|
|
5557
|
-
description: 'ID of the action attempt.',
|
|
5558
|
-
format: 'uuid',
|
|
5559
|
-
type: 'string',
|
|
5560
|
-
},
|
|
5561
|
-
action_type: {
|
|
5562
|
-
description:
|
|
5563
|
-
'Action attempt to track the status of encoding an access method from the physical encoder onto a card.',
|
|
5564
|
-
enum: ['ENCODE_ACCESS_METHOD'],
|
|
5565
|
-
type: 'string',
|
|
5566
|
-
},
|
|
5567
|
-
error: {
|
|
5568
|
-
description:
|
|
5569
|
-
'Errors associated with the action attempt. Null for successful action attempts.',
|
|
5570
|
-
nullable: true,
|
|
5571
|
-
},
|
|
5572
|
-
result: {
|
|
5573
|
-
description:
|
|
5574
|
-
'Result of an encoding attempt. If the attempt was successful, includes the access method data that was encoded onto the card.',
|
|
5575
|
-
properties: {
|
|
5576
|
-
access_method_id: {
|
|
5577
|
-
description: 'ID of the access method.',
|
|
5578
|
-
format: 'uuid',
|
|
5579
|
-
type: 'string',
|
|
5580
|
-
},
|
|
5581
|
-
created_at: {
|
|
5582
|
-
description:
|
|
5583
|
-
'Date and time at which the access method was created.',
|
|
5584
|
-
format: 'date-time',
|
|
5585
|
-
type: 'string',
|
|
5586
|
-
},
|
|
5587
|
-
display_name: {
|
|
5588
|
-
description: 'Display name of the access method.',
|
|
5589
|
-
type: 'string',
|
|
5590
|
-
},
|
|
5591
|
-
instant_key_url: {
|
|
5592
|
-
description:
|
|
5593
|
-
'URL of the Instant Key for mobile key access methods.',
|
|
5594
|
-
format: 'uri',
|
|
5595
|
-
type: 'string',
|
|
5596
|
-
},
|
|
5597
|
-
is_card_encoding_required: {
|
|
5598
|
-
description:
|
|
5599
|
-
'Indicates whether card encoding is required for plastic card access methods.',
|
|
5600
|
-
type: 'boolean',
|
|
5601
|
-
},
|
|
5602
|
-
issued_at: {
|
|
5603
|
-
description:
|
|
5604
|
-
'Date and time at which the access method was issued.',
|
|
5605
|
-
format: 'date-time',
|
|
5606
|
-
type: 'string',
|
|
5607
|
-
},
|
|
5608
|
-
mode: {
|
|
5609
|
-
description:
|
|
5610
|
-
'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
|
|
5611
|
-
enum: ['code', 'card', 'mobile_key'],
|
|
5612
|
-
type: 'string',
|
|
5613
|
-
},
|
|
5614
|
-
workspace_id: {
|
|
5615
|
-
description:
|
|
5616
|
-
'ID of the Seam workspace associated with the access method.',
|
|
5617
|
-
format: 'uuid',
|
|
5618
|
-
type: 'string',
|
|
5619
|
-
},
|
|
5620
|
-
},
|
|
5621
|
-
required: [
|
|
5622
|
-
'workspace_id',
|
|
5623
|
-
'access_method_id',
|
|
5624
|
-
'display_name',
|
|
5625
|
-
'mode',
|
|
5626
|
-
'created_at',
|
|
5627
|
-
],
|
|
5628
|
-
type: 'object',
|
|
5629
|
-
},
|
|
5630
|
-
status: { enum: ['success'], type: 'string' },
|
|
5631
|
-
},
|
|
5632
|
-
required: [
|
|
5633
|
-
'action_attempt_id',
|
|
5634
|
-
'status',
|
|
5635
|
-
'error',
|
|
5636
|
-
'action_type',
|
|
5637
|
-
'result',
|
|
5638
|
-
],
|
|
5639
|
-
type: 'object',
|
|
5640
|
-
},
|
|
5641
|
-
{
|
|
5642
|
-
description:
|
|
5643
|
-
'Encoding access method data from the physical encoder onto a card failed.',
|
|
5644
|
-
properties: {
|
|
5645
|
-
action_attempt_id: {
|
|
5646
|
-
description: 'ID of the action attempt.',
|
|
5647
|
-
format: 'uuid',
|
|
5648
|
-
type: 'string',
|
|
5649
|
-
},
|
|
5650
|
-
action_type: {
|
|
5651
|
-
description:
|
|
5652
|
-
'Action attempt to track the status of encoding an access method from the physical encoder onto a card.',
|
|
5653
|
-
enum: ['ENCODE_ACCESS_METHOD'],
|
|
5654
|
-
type: 'string',
|
|
5655
|
-
},
|
|
5656
|
-
error: {
|
|
5657
|
-
oneOf: [
|
|
5658
|
-
{
|
|
5659
|
-
description:
|
|
5660
|
-
"Error that doesn't fit into other specific error categories.",
|
|
5661
|
-
properties: {
|
|
5662
|
-
message: {
|
|
5663
|
-
description:
|
|
5664
|
-
'Message for the error associated with the action attempt.',
|
|
5665
|
-
type: 'string',
|
|
5666
|
-
},
|
|
5667
|
-
type: {
|
|
5668
|
-
description:
|
|
5669
|
-
'Type of the error associated with the action attempt.',
|
|
5670
|
-
enum: ['uncategorized_error'],
|
|
5671
|
-
type: 'string',
|
|
5672
|
-
},
|
|
5673
|
-
},
|
|
5674
|
-
required: ['type', 'message'],
|
|
5675
|
-
type: 'object',
|
|
5676
|
-
},
|
|
5677
|
-
{
|
|
5678
|
-
description: 'Error to indicate an expired action attempt.',
|
|
5679
|
-
properties: {
|
|
5680
|
-
message: {
|
|
5681
|
-
description:
|
|
5682
|
-
'Message for the error associated with the action attempt.',
|
|
5683
|
-
type: 'string',
|
|
5684
|
-
},
|
|
5685
|
-
type: {
|
|
5686
|
-
description:
|
|
5687
|
-
'Type of the error associated with the action attempt.',
|
|
5688
|
-
enum: ['action_attempt_expired'],
|
|
5689
|
-
type: 'string',
|
|
5690
|
-
},
|
|
5691
|
-
},
|
|
5692
|
-
required: ['type', 'message'],
|
|
5693
|
-
type: 'object',
|
|
5694
|
-
},
|
|
5695
|
-
{
|
|
5696
|
-
description:
|
|
5697
|
-
'Error to indicate that there is no credential on the encoder.',
|
|
5698
|
-
properties: {
|
|
5699
|
-
message: {
|
|
5700
|
-
description:
|
|
5701
|
-
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
5702
|
-
type: 'string',
|
|
5703
|
-
},
|
|
5704
|
-
type: {
|
|
5705
|
-
description:
|
|
5706
|
-
'Error type to indicate that there is no credential on the encoder.',
|
|
5707
|
-
enum: ['no_credential_on_encoder'],
|
|
5708
|
-
type: 'string',
|
|
5709
|
-
},
|
|
5710
|
-
},
|
|
5711
|
-
required: ['type', 'message'],
|
|
5712
|
-
type: 'object',
|
|
5713
|
-
},
|
|
5714
|
-
{
|
|
5715
|
-
description:
|
|
5716
|
-
'Error to indicate an incompatible card format.',
|
|
5717
|
-
properties: {
|
|
5718
|
-
message: {
|
|
5719
|
-
description:
|
|
5720
|
-
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
5721
|
-
type: 'string',
|
|
5722
|
-
},
|
|
5723
|
-
type: {
|
|
5724
|
-
description:
|
|
5725
|
-
'Error type to indicate an incompatible card format.',
|
|
5726
|
-
enum: ['incompatible_card_format'],
|
|
5727
|
-
type: 'string',
|
|
5728
|
-
},
|
|
5729
|
-
},
|
|
5730
|
-
required: ['type', 'message'],
|
|
5731
|
-
type: 'object',
|
|
5732
|
-
},
|
|
5733
|
-
{
|
|
5734
|
-
description:
|
|
5735
|
-
'Error to indicate that the affected credential cannot be reissued.',
|
|
5736
|
-
properties: {
|
|
5737
|
-
message: {
|
|
5738
|
-
description:
|
|
5739
|
-
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
5740
|
-
type: 'string',
|
|
5741
|
-
},
|
|
5742
|
-
type: {
|
|
5743
|
-
description:
|
|
5744
|
-
'Error type to indicate that the affected credential cannot be reissued.',
|
|
5745
|
-
enum: ['credential_cannot_be_reissued'],
|
|
5746
|
-
type: 'string',
|
|
5747
|
-
},
|
|
5748
|
-
},
|
|
5749
|
-
required: ['type', 'message'],
|
|
5750
|
-
type: 'object',
|
|
5751
|
-
},
|
|
5752
|
-
],
|
|
5753
|
-
},
|
|
5754
|
-
result: {
|
|
5755
|
-
description:
|
|
5756
|
-
'Result of the action attempt. Null for failed action attempts.',
|
|
5757
|
-
nullable: true,
|
|
5758
|
-
},
|
|
5759
|
-
status: { enum: ['error'], type: 'string' },
|
|
5760
|
-
},
|
|
5761
|
-
required: [
|
|
5762
|
-
'action_attempt_id',
|
|
5763
|
-
'status',
|
|
5764
|
-
'result',
|
|
5765
|
-
'action_type',
|
|
5766
|
-
'error',
|
|
5767
|
-
],
|
|
5768
|
-
type: 'object',
|
|
5769
|
-
},
|
|
5770
5516
|
{
|
|
5771
5517
|
description:
|
|
5772
5518
|
'Encoding credential data from the physical encoder onto a card is pending.',
|
|
@@ -27392,6 +27138,71 @@ export default {
|
|
|
27392
27138
|
'x-title': 'Delete an Access Method',
|
|
27393
27139
|
},
|
|
27394
27140
|
},
|
|
27141
|
+
'/access_methods/encode': {
|
|
27142
|
+
post: {
|
|
27143
|
+
description:
|
|
27144
|
+
'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).',
|
|
27145
|
+
operationId: 'accessMethodsEncodePost',
|
|
27146
|
+
requestBody: {
|
|
27147
|
+
content: {
|
|
27148
|
+
'application/json': {
|
|
27149
|
+
schema: {
|
|
27150
|
+
properties: {
|
|
27151
|
+
access_method_id: {
|
|
27152
|
+
description:
|
|
27153
|
+
'ID of the `access_method` to encode onto a card.',
|
|
27154
|
+
format: 'uuid',
|
|
27155
|
+
type: 'string',
|
|
27156
|
+
},
|
|
27157
|
+
acs_encoder_id: {
|
|
27158
|
+
description:
|
|
27159
|
+
'ID of the `acs_encoder` to use to encode the `acs_credential`.',
|
|
27160
|
+
format: 'uuid',
|
|
27161
|
+
type: 'string',
|
|
27162
|
+
},
|
|
27163
|
+
},
|
|
27164
|
+
required: ['acs_encoder_id', 'access_method_id'],
|
|
27165
|
+
type: 'object',
|
|
27166
|
+
},
|
|
27167
|
+
},
|
|
27168
|
+
},
|
|
27169
|
+
},
|
|
27170
|
+
responses: {
|
|
27171
|
+
200: {
|
|
27172
|
+
content: {
|
|
27173
|
+
'application/json': {
|
|
27174
|
+
schema: {
|
|
27175
|
+
properties: {
|
|
27176
|
+
action_attempt: {
|
|
27177
|
+
$ref: '#/components/schemas/action_attempt',
|
|
27178
|
+
},
|
|
27179
|
+
ok: { type: 'boolean' },
|
|
27180
|
+
},
|
|
27181
|
+
required: ['action_attempt', 'ok'],
|
|
27182
|
+
type: 'object',
|
|
27183
|
+
},
|
|
27184
|
+
},
|
|
27185
|
+
},
|
|
27186
|
+
description: 'OK',
|
|
27187
|
+
},
|
|
27188
|
+
400: { description: 'Bad Request' },
|
|
27189
|
+
401: { description: 'Unauthorized' },
|
|
27190
|
+
},
|
|
27191
|
+
security: [
|
|
27192
|
+
{ pat_with_workspace: [] },
|
|
27193
|
+
{ console_session_with_workspace: [] },
|
|
27194
|
+
{ api_key: [] },
|
|
27195
|
+
],
|
|
27196
|
+
summary: '/access_methods/encode',
|
|
27197
|
+
tags: [],
|
|
27198
|
+
'x-action-attempt-type': 'ENCODE_CREDENTIAL',
|
|
27199
|
+
'x-fern-sdk-group-name': ['access_methods'],
|
|
27200
|
+
'x-fern-sdk-method-name': 'encode',
|
|
27201
|
+
'x-fern-sdk-return-value': 'action_attempt',
|
|
27202
|
+
'x-response-key': 'action_attempt',
|
|
27203
|
+
'x-title': 'Encode an Access Method',
|
|
27204
|
+
},
|
|
27205
|
+
},
|
|
27395
27206
|
'/access_methods/get': {
|
|
27396
27207
|
get: {
|
|
27397
27208
|
description: 'Get an access method.',
|
|
@@ -30216,11 +30027,11 @@ export default {
|
|
|
30216
30027
|
'x-title': 'Update a Credential',
|
|
30217
30028
|
},
|
|
30218
30029
|
},
|
|
30219
|
-
'/acs/encoders/
|
|
30030
|
+
'/acs/encoders/encode_credential': {
|
|
30220
30031
|
post: {
|
|
30221
30032
|
description:
|
|
30222
|
-
'Encodes an existing access
|
|
30223
|
-
operationId: '
|
|
30033
|
+
'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`',
|
|
30034
|
+
operationId: 'acsEncodersEncodeCredentialPost',
|
|
30224
30035
|
requestBody: {
|
|
30225
30036
|
content: {
|
|
30226
30037
|
'application/json': {
|
|
@@ -30232,65 +30043,6 @@ export default {
|
|
|
30232
30043
|
format: 'uuid',
|
|
30233
30044
|
type: 'string',
|
|
30234
30045
|
},
|
|
30235
|
-
acs_encoder_id: {
|
|
30236
|
-
description:
|
|
30237
|
-
'ID of the `acs_encoder` to use to encode the `access_method`.',
|
|
30238
|
-
format: 'uuid',
|
|
30239
|
-
type: 'string',
|
|
30240
|
-
},
|
|
30241
|
-
},
|
|
30242
|
-
required: ['acs_encoder_id', 'access_method_id'],
|
|
30243
|
-
type: 'object',
|
|
30244
|
-
},
|
|
30245
|
-
},
|
|
30246
|
-
},
|
|
30247
|
-
},
|
|
30248
|
-
responses: {
|
|
30249
|
-
200: {
|
|
30250
|
-
content: {
|
|
30251
|
-
'application/json': {
|
|
30252
|
-
schema: {
|
|
30253
|
-
properties: {
|
|
30254
|
-
action_attempt: {
|
|
30255
|
-
$ref: '#/components/schemas/action_attempt',
|
|
30256
|
-
},
|
|
30257
|
-
ok: { type: 'boolean' },
|
|
30258
|
-
},
|
|
30259
|
-
required: ['action_attempt', 'ok'],
|
|
30260
|
-
type: 'object',
|
|
30261
|
-
},
|
|
30262
|
-
},
|
|
30263
|
-
},
|
|
30264
|
-
description: 'OK',
|
|
30265
|
-
},
|
|
30266
|
-
400: { description: 'Bad Request' },
|
|
30267
|
-
401: { description: 'Unauthorized' },
|
|
30268
|
-
},
|
|
30269
|
-
security: [
|
|
30270
|
-
{ pat_with_workspace: [] },
|
|
30271
|
-
{ console_session_with_workspace: [] },
|
|
30272
|
-
{ api_key: [] },
|
|
30273
|
-
],
|
|
30274
|
-
summary: '/acs/encoders/encode_access_method',
|
|
30275
|
-
tags: ['/acs'],
|
|
30276
|
-
'x-action-attempt-type': 'ENCODE_ACCESS_METHOD',
|
|
30277
|
-
'x-fern-sdk-group-name': ['acs', 'encoders'],
|
|
30278
|
-
'x-fern-sdk-method-name': 'encode_access_method',
|
|
30279
|
-
'x-fern-sdk-return-value': 'action_attempt',
|
|
30280
|
-
'x-response-key': 'action_attempt',
|
|
30281
|
-
'x-title': 'Encode an Access Method',
|
|
30282
|
-
},
|
|
30283
|
-
},
|
|
30284
|
-
'/acs/encoders/encode_credential': {
|
|
30285
|
-
post: {
|
|
30286
|
-
description:
|
|
30287
|
-
'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).',
|
|
30288
|
-
operationId: 'acsEncodersEncodeCredentialPost',
|
|
30289
|
-
requestBody: {
|
|
30290
|
-
content: {
|
|
30291
|
-
'application/json': {
|
|
30292
|
-
schema: {
|
|
30293
|
-
properties: {
|
|
30294
30046
|
acs_credential_id: {
|
|
30295
30047
|
description:
|
|
30296
30048
|
'ID of the `acs_credential` to encode onto a card.',
|
|
@@ -30304,7 +30056,7 @@ export default {
|
|
|
30304
30056
|
type: 'string',
|
|
30305
30057
|
},
|
|
30306
30058
|
},
|
|
30307
|
-
required: ['acs_encoder_id'
|
|
30059
|
+
required: ['acs_encoder_id'],
|
|
30308
30060
|
type: 'object',
|
|
30309
30061
|
},
|
|
30310
30062
|
},
|
|
@@ -44106,6 +43858,695 @@ export default {
|
|
|
44106
43858
|
'x-undocumented': 'Seam Bridge Client only.',
|
|
44107
43859
|
},
|
|
44108
43860
|
},
|
|
43861
|
+
'/seam/customer/v1/automation_runs/list': {
|
|
43862
|
+
get: {
|
|
43863
|
+
description:
|
|
43864
|
+
'Returns a list of all automation runs for a workspace or customer.',
|
|
43865
|
+
operationId: 'seamCustomerV1AutomationRunsListGet',
|
|
43866
|
+
parameters: [
|
|
43867
|
+
{
|
|
43868
|
+
in: 'query',
|
|
43869
|
+
name: 'automation_id',
|
|
43870
|
+
schema: {
|
|
43871
|
+
description:
|
|
43872
|
+
'ID of the automation for which you want to retrieve all automation runs.',
|
|
43873
|
+
format: 'uuid',
|
|
43874
|
+
type: 'string',
|
|
43875
|
+
},
|
|
43876
|
+
},
|
|
43877
|
+
{
|
|
43878
|
+
in: 'query',
|
|
43879
|
+
name: 'partner_resource_id',
|
|
43880
|
+
schema: {
|
|
43881
|
+
description:
|
|
43882
|
+
'ID of the partner resource for which you want to retrieve all automation runs.',
|
|
43883
|
+
format: 'uuid',
|
|
43884
|
+
type: 'string',
|
|
43885
|
+
},
|
|
43886
|
+
},
|
|
43887
|
+
{
|
|
43888
|
+
in: 'query',
|
|
43889
|
+
name: 'rule',
|
|
43890
|
+
schema: {
|
|
43891
|
+
description:
|
|
43892
|
+
'Filter automation runs by the specific rule that was executed.',
|
|
43893
|
+
enum: [
|
|
43894
|
+
'reservation_created',
|
|
43895
|
+
'reservation_time_updated',
|
|
43896
|
+
'reservation_deleted',
|
|
43897
|
+
],
|
|
43898
|
+
type: 'string',
|
|
43899
|
+
},
|
|
43900
|
+
},
|
|
43901
|
+
{
|
|
43902
|
+
in: 'query',
|
|
43903
|
+
name: 'success',
|
|
43904
|
+
schema: {
|
|
43905
|
+
description: 'Filter automation runs by success status.',
|
|
43906
|
+
type: 'boolean',
|
|
43907
|
+
},
|
|
43908
|
+
},
|
|
43909
|
+
{
|
|
43910
|
+
in: 'query',
|
|
43911
|
+
name: 'limit',
|
|
43912
|
+
schema: {
|
|
43913
|
+
default: 500,
|
|
43914
|
+
description: 'Maximum number of records to return per page.',
|
|
43915
|
+
exclusiveMinimum: true,
|
|
43916
|
+
minimum: 0,
|
|
43917
|
+
type: 'integer',
|
|
43918
|
+
},
|
|
43919
|
+
},
|
|
43920
|
+
{
|
|
43921
|
+
in: 'query',
|
|
43922
|
+
name: 'created_before',
|
|
43923
|
+
schema: {
|
|
43924
|
+
description:
|
|
43925
|
+
'Timestamp by which to limit returned automation runs. Returns runs created before this timestamp.',
|
|
43926
|
+
format: 'date-time',
|
|
43927
|
+
type: 'string',
|
|
43928
|
+
},
|
|
43929
|
+
},
|
|
43930
|
+
{
|
|
43931
|
+
in: 'query',
|
|
43932
|
+
name: 'page_cursor',
|
|
43933
|
+
schema: {
|
|
43934
|
+
description:
|
|
43935
|
+
"Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
|
|
43936
|
+
nullable: true,
|
|
43937
|
+
type: 'string',
|
|
43938
|
+
},
|
|
43939
|
+
},
|
|
43940
|
+
],
|
|
43941
|
+
responses: {
|
|
43942
|
+
200: {
|
|
43943
|
+
content: {
|
|
43944
|
+
'application/json': {
|
|
43945
|
+
schema: {
|
|
43946
|
+
properties: {
|
|
43947
|
+
automation_runs: {
|
|
43948
|
+
items: {
|
|
43949
|
+
properties: {
|
|
43950
|
+
automation_id: { format: 'uuid', type: 'string' },
|
|
43951
|
+
automation_result: {
|
|
43952
|
+
properties: {
|
|
43953
|
+
actions: {
|
|
43954
|
+
items: {
|
|
43955
|
+
properties: {
|
|
43956
|
+
access_grant_id: {
|
|
43957
|
+
format: 'uuid',
|
|
43958
|
+
type: 'string',
|
|
43959
|
+
},
|
|
43960
|
+
action_type: {
|
|
43961
|
+
enum: ['create', 'update', 'delete'],
|
|
43962
|
+
type: 'string',
|
|
43963
|
+
},
|
|
43964
|
+
resource_type: { type: 'string' },
|
|
43965
|
+
},
|
|
43966
|
+
required: [
|
|
43967
|
+
'action_type',
|
|
43968
|
+
'resource_type',
|
|
43969
|
+
'access_grant_id',
|
|
43970
|
+
],
|
|
43971
|
+
type: 'object',
|
|
43972
|
+
},
|
|
43973
|
+
type: 'array',
|
|
43974
|
+
},
|
|
43975
|
+
error: { type: 'string' },
|
|
43976
|
+
rule: {
|
|
43977
|
+
enum: [
|
|
43978
|
+
'reservation_created',
|
|
43979
|
+
'reservation_time_updated',
|
|
43980
|
+
'reservation_deleted',
|
|
43981
|
+
],
|
|
43982
|
+
type: 'string',
|
|
43983
|
+
},
|
|
43984
|
+
success: { type: 'boolean' },
|
|
43985
|
+
},
|
|
43986
|
+
required: ['success', 'rule', 'actions'],
|
|
43987
|
+
type: 'object',
|
|
43988
|
+
},
|
|
43989
|
+
automation_run_id: { format: 'uuid', type: 'string' },
|
|
43990
|
+
created_at: { type: 'string' },
|
|
43991
|
+
partner_resource_id: {
|
|
43992
|
+
format: 'uuid',
|
|
43993
|
+
type: 'string',
|
|
43994
|
+
},
|
|
43995
|
+
workspace_id: { format: 'uuid', type: 'string' },
|
|
43996
|
+
},
|
|
43997
|
+
required: [
|
|
43998
|
+
'automation_run_id',
|
|
43999
|
+
'workspace_id',
|
|
44000
|
+
'automation_id',
|
|
44001
|
+
'partner_resource_id',
|
|
44002
|
+
'created_at',
|
|
44003
|
+
],
|
|
44004
|
+
type: 'object',
|
|
44005
|
+
},
|
|
44006
|
+
type: 'array',
|
|
44007
|
+
},
|
|
44008
|
+
ok: { type: 'boolean' },
|
|
44009
|
+
pagination: { $ref: '#/components/schemas/pagination' },
|
|
44010
|
+
},
|
|
44011
|
+
required: ['automation_runs', 'pagination', 'ok'],
|
|
44012
|
+
type: 'object',
|
|
44013
|
+
},
|
|
44014
|
+
},
|
|
44015
|
+
},
|
|
44016
|
+
description: 'OK',
|
|
44017
|
+
},
|
|
44018
|
+
400: { description: 'Bad Request' },
|
|
44019
|
+
401: { description: 'Unauthorized' },
|
|
44020
|
+
},
|
|
44021
|
+
security: [
|
|
44022
|
+
{ console_session_with_workspace: [] },
|
|
44023
|
+
{ api_key: [] },
|
|
44024
|
+
{ client_session_with_customer: [] },
|
|
44025
|
+
],
|
|
44026
|
+
summary: '/seam/customer/v1/automation_runs/list',
|
|
44027
|
+
tags: [],
|
|
44028
|
+
'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'automation_runs'],
|
|
44029
|
+
'x-fern-sdk-method-name': 'list',
|
|
44030
|
+
'x-fern-sdk-return-value': 'automation_runs',
|
|
44031
|
+
'x-response-key': 'automation_runs',
|
|
44032
|
+
'x-title': 'List Automation Runs',
|
|
44033
|
+
'x-undocumented': 'Internal endpoint for customer portals.',
|
|
44034
|
+
},
|
|
44035
|
+
post: {
|
|
44036
|
+
description:
|
|
44037
|
+
'Returns a list of all automation runs for a workspace or customer.',
|
|
44038
|
+
operationId: 'seamCustomerV1AutomationRunsListPost',
|
|
44039
|
+
requestBody: {
|
|
44040
|
+
content: {
|
|
44041
|
+
'application/json': {
|
|
44042
|
+
schema: {
|
|
44043
|
+
properties: {
|
|
44044
|
+
automation_id: {
|
|
44045
|
+
description:
|
|
44046
|
+
'ID of the automation for which you want to retrieve all automation runs.',
|
|
44047
|
+
format: 'uuid',
|
|
44048
|
+
type: 'string',
|
|
44049
|
+
},
|
|
44050
|
+
created_before: {
|
|
44051
|
+
description:
|
|
44052
|
+
'Timestamp by which to limit returned automation runs. Returns runs created before this timestamp.',
|
|
44053
|
+
format: 'date-time',
|
|
44054
|
+
type: 'string',
|
|
44055
|
+
},
|
|
44056
|
+
limit: {
|
|
44057
|
+
default: 500,
|
|
44058
|
+
description:
|
|
44059
|
+
'Maximum number of records to return per page.',
|
|
44060
|
+
exclusiveMinimum: true,
|
|
44061
|
+
minimum: 0,
|
|
44062
|
+
type: 'integer',
|
|
44063
|
+
},
|
|
44064
|
+
page_cursor: {
|
|
44065
|
+
description:
|
|
44066
|
+
"Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
|
|
44067
|
+
nullable: true,
|
|
44068
|
+
type: 'string',
|
|
44069
|
+
},
|
|
44070
|
+
partner_resource_id: {
|
|
44071
|
+
description:
|
|
44072
|
+
'ID of the partner resource for which you want to retrieve all automation runs.',
|
|
44073
|
+
format: 'uuid',
|
|
44074
|
+
type: 'string',
|
|
44075
|
+
},
|
|
44076
|
+
rule: {
|
|
44077
|
+
description:
|
|
44078
|
+
'Filter automation runs by the specific rule that was executed.',
|
|
44079
|
+
enum: [
|
|
44080
|
+
'reservation_created',
|
|
44081
|
+
'reservation_time_updated',
|
|
44082
|
+
'reservation_deleted',
|
|
44083
|
+
],
|
|
44084
|
+
type: 'string',
|
|
44085
|
+
},
|
|
44086
|
+
success: {
|
|
44087
|
+
description: 'Filter automation runs by success status.',
|
|
44088
|
+
type: 'boolean',
|
|
44089
|
+
},
|
|
44090
|
+
},
|
|
44091
|
+
type: 'object',
|
|
44092
|
+
},
|
|
44093
|
+
},
|
|
44094
|
+
},
|
|
44095
|
+
},
|
|
44096
|
+
responses: {
|
|
44097
|
+
200: {
|
|
44098
|
+
content: {
|
|
44099
|
+
'application/json': {
|
|
44100
|
+
schema: {
|
|
44101
|
+
properties: {
|
|
44102
|
+
automation_runs: {
|
|
44103
|
+
items: {
|
|
44104
|
+
properties: {
|
|
44105
|
+
automation_id: { format: 'uuid', type: 'string' },
|
|
44106
|
+
automation_result: {
|
|
44107
|
+
properties: {
|
|
44108
|
+
actions: {
|
|
44109
|
+
items: {
|
|
44110
|
+
properties: {
|
|
44111
|
+
access_grant_id: {
|
|
44112
|
+
format: 'uuid',
|
|
44113
|
+
type: 'string',
|
|
44114
|
+
},
|
|
44115
|
+
action_type: {
|
|
44116
|
+
enum: ['create', 'update', 'delete'],
|
|
44117
|
+
type: 'string',
|
|
44118
|
+
},
|
|
44119
|
+
resource_type: { type: 'string' },
|
|
44120
|
+
},
|
|
44121
|
+
required: [
|
|
44122
|
+
'action_type',
|
|
44123
|
+
'resource_type',
|
|
44124
|
+
'access_grant_id',
|
|
44125
|
+
],
|
|
44126
|
+
type: 'object',
|
|
44127
|
+
},
|
|
44128
|
+
type: 'array',
|
|
44129
|
+
},
|
|
44130
|
+
error: { type: 'string' },
|
|
44131
|
+
rule: {
|
|
44132
|
+
enum: [
|
|
44133
|
+
'reservation_created',
|
|
44134
|
+
'reservation_time_updated',
|
|
44135
|
+
'reservation_deleted',
|
|
44136
|
+
],
|
|
44137
|
+
type: 'string',
|
|
44138
|
+
},
|
|
44139
|
+
success: { type: 'boolean' },
|
|
44140
|
+
},
|
|
44141
|
+
required: ['success', 'rule', 'actions'],
|
|
44142
|
+
type: 'object',
|
|
44143
|
+
},
|
|
44144
|
+
automation_run_id: { format: 'uuid', type: 'string' },
|
|
44145
|
+
created_at: { type: 'string' },
|
|
44146
|
+
partner_resource_id: {
|
|
44147
|
+
format: 'uuid',
|
|
44148
|
+
type: 'string',
|
|
44149
|
+
},
|
|
44150
|
+
workspace_id: { format: 'uuid', type: 'string' },
|
|
44151
|
+
},
|
|
44152
|
+
required: [
|
|
44153
|
+
'automation_run_id',
|
|
44154
|
+
'workspace_id',
|
|
44155
|
+
'automation_id',
|
|
44156
|
+
'partner_resource_id',
|
|
44157
|
+
'created_at',
|
|
44158
|
+
],
|
|
44159
|
+
type: 'object',
|
|
44160
|
+
},
|
|
44161
|
+
type: 'array',
|
|
44162
|
+
},
|
|
44163
|
+
ok: { type: 'boolean' },
|
|
44164
|
+
pagination: { $ref: '#/components/schemas/pagination' },
|
|
44165
|
+
},
|
|
44166
|
+
required: ['automation_runs', 'pagination', 'ok'],
|
|
44167
|
+
type: 'object',
|
|
44168
|
+
},
|
|
44169
|
+
},
|
|
44170
|
+
},
|
|
44171
|
+
description: 'OK',
|
|
44172
|
+
},
|
|
44173
|
+
400: { description: 'Bad Request' },
|
|
44174
|
+
401: { description: 'Unauthorized' },
|
|
44175
|
+
},
|
|
44176
|
+
security: [
|
|
44177
|
+
{ console_session_with_workspace: [] },
|
|
44178
|
+
{ api_key: [] },
|
|
44179
|
+
{ client_session_with_customer: [] },
|
|
44180
|
+
],
|
|
44181
|
+
summary: '/seam/customer/v1/automation_runs/list',
|
|
44182
|
+
tags: [],
|
|
44183
|
+
'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'automation_runs'],
|
|
44184
|
+
'x-fern-sdk-method-name': 'list',
|
|
44185
|
+
'x-fern-sdk-return-value': 'automation_runs',
|
|
44186
|
+
'x-response-key': 'automation_runs',
|
|
44187
|
+
'x-title': 'List Automation Runs',
|
|
44188
|
+
'x-undocumented': 'Internal endpoint for customer portals.',
|
|
44189
|
+
},
|
|
44190
|
+
},
|
|
44191
|
+
'/seam/customer/v1/automations/delete': {
|
|
44192
|
+
delete: {
|
|
44193
|
+
description:
|
|
44194
|
+
'Deletes the automation configuration for a customer portal workspace.\nSupports both console session and customer client session authentication.',
|
|
44195
|
+
operationId: 'seamCustomerV1AutomationsDeleteDelete',
|
|
44196
|
+
requestBody: {
|
|
44197
|
+
content: {
|
|
44198
|
+
'application/json': { schema: { properties: {}, type: 'object' } },
|
|
44199
|
+
},
|
|
44200
|
+
},
|
|
44201
|
+
responses: {
|
|
44202
|
+
200: {
|
|
44203
|
+
content: {
|
|
44204
|
+
'application/json': {
|
|
44205
|
+
schema: {
|
|
44206
|
+
properties: { ok: { type: 'boolean' } },
|
|
44207
|
+
required: ['ok'],
|
|
44208
|
+
type: 'object',
|
|
44209
|
+
},
|
|
44210
|
+
},
|
|
44211
|
+
},
|
|
44212
|
+
description: 'OK',
|
|
44213
|
+
},
|
|
44214
|
+
400: { description: 'Bad Request' },
|
|
44215
|
+
401: { description: 'Unauthorized' },
|
|
44216
|
+
},
|
|
44217
|
+
security: [
|
|
44218
|
+
{ console_session_with_workspace: [] },
|
|
44219
|
+
{ api_key: [] },
|
|
44220
|
+
{ client_session_with_customer: [] },
|
|
44221
|
+
],
|
|
44222
|
+
summary: '/seam/customer/v1/automations/delete',
|
|
44223
|
+
tags: [],
|
|
44224
|
+
'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'automations'],
|
|
44225
|
+
'x-fern-sdk-method-name': 'delete',
|
|
44226
|
+
'x-response-key': null,
|
|
44227
|
+
'x-title': 'Delete Customer Portal Automation Configuration',
|
|
44228
|
+
'x-undocumented': 'Internal endpoint for customer portals.',
|
|
44229
|
+
},
|
|
44230
|
+
},
|
|
44231
|
+
'/seam/customer/v1/automations/get': {
|
|
44232
|
+
get: {
|
|
44233
|
+
description:
|
|
44234
|
+
'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.',
|
|
44235
|
+
operationId: 'seamCustomerV1AutomationsGetGet',
|
|
44236
|
+
responses: {
|
|
44237
|
+
200: {
|
|
44238
|
+
content: {
|
|
44239
|
+
'application/json': {
|
|
44240
|
+
schema: {
|
|
44241
|
+
properties: {
|
|
44242
|
+
access_rules: {
|
|
44243
|
+
properties: {
|
|
44244
|
+
reservation_created: {
|
|
44245
|
+
properties: {
|
|
44246
|
+
config: {
|
|
44247
|
+
properties: {
|
|
44248
|
+
access_methods: {
|
|
44249
|
+
items: {
|
|
44250
|
+
enum: ['card', 'mobile_key', 'code'],
|
|
44251
|
+
type: 'string',
|
|
44252
|
+
},
|
|
44253
|
+
minItems: 1,
|
|
44254
|
+
type: 'array',
|
|
44255
|
+
},
|
|
44256
|
+
method_issuance_strategy: {
|
|
44257
|
+
enum: [
|
|
44258
|
+
'first_available',
|
|
44259
|
+
'first_two_available',
|
|
44260
|
+
'all_available',
|
|
44261
|
+
],
|
|
44262
|
+
type: 'string',
|
|
44263
|
+
},
|
|
44264
|
+
},
|
|
44265
|
+
required: [
|
|
44266
|
+
'access_methods',
|
|
44267
|
+
'method_issuance_strategy',
|
|
44268
|
+
],
|
|
44269
|
+
type: 'object',
|
|
44270
|
+
},
|
|
44271
|
+
rule: {
|
|
44272
|
+
enum: ['reservation_created'],
|
|
44273
|
+
type: 'string',
|
|
44274
|
+
},
|
|
44275
|
+
},
|
|
44276
|
+
required: ['rule', 'config'],
|
|
44277
|
+
type: 'object',
|
|
44278
|
+
},
|
|
44279
|
+
reservation_deleted: {
|
|
44280
|
+
properties: {
|
|
44281
|
+
config: {
|
|
44282
|
+
$ref: '#/components/schemas/access_code',
|
|
44283
|
+
},
|
|
44284
|
+
rule: {
|
|
44285
|
+
enum: ['reservation_deleted'],
|
|
44286
|
+
type: 'string',
|
|
44287
|
+
},
|
|
44288
|
+
},
|
|
44289
|
+
required: ['rule', 'config'],
|
|
44290
|
+
type: 'object',
|
|
44291
|
+
},
|
|
44292
|
+
reservation_time_updated: {
|
|
44293
|
+
properties: {
|
|
44294
|
+
config: {
|
|
44295
|
+
$ref: '#/components/schemas/access_code',
|
|
44296
|
+
},
|
|
44297
|
+
rule: {
|
|
44298
|
+
enum: ['reservation_time_updated'],
|
|
44299
|
+
type: 'string',
|
|
44300
|
+
},
|
|
44301
|
+
},
|
|
44302
|
+
required: ['rule', 'config'],
|
|
44303
|
+
type: 'object',
|
|
44304
|
+
},
|
|
44305
|
+
},
|
|
44306
|
+
type: 'object',
|
|
44307
|
+
},
|
|
44308
|
+
ok: { type: 'boolean' },
|
|
44309
|
+
},
|
|
44310
|
+
required: ['ok'],
|
|
44311
|
+
type: 'object',
|
|
44312
|
+
},
|
|
44313
|
+
},
|
|
44314
|
+
},
|
|
44315
|
+
description: 'OK',
|
|
44316
|
+
},
|
|
44317
|
+
400: { description: 'Bad Request' },
|
|
44318
|
+
401: { description: 'Unauthorized' },
|
|
44319
|
+
},
|
|
44320
|
+
security: [
|
|
44321
|
+
{ console_session_with_workspace: [] },
|
|
44322
|
+
{ api_key: [] },
|
|
44323
|
+
{ client_session_with_customer: [] },
|
|
44324
|
+
],
|
|
44325
|
+
summary: '/seam/customer/v1/automations/get',
|
|
44326
|
+
tags: [],
|
|
44327
|
+
'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'automations'],
|
|
44328
|
+
'x-fern-sdk-method-name': 'get',
|
|
44329
|
+
'x-response-key': null,
|
|
44330
|
+
'x-title': 'Get Customer Portal Automation Configuration',
|
|
44331
|
+
'x-undocumented': 'Internal endpoint for customer portals.',
|
|
44332
|
+
},
|
|
44333
|
+
},
|
|
44334
|
+
'/seam/customer/v1/automations/update': {
|
|
44335
|
+
patch: {
|
|
44336
|
+
description:
|
|
44337
|
+
'Updates the automation configuration for a customer portal workspace.\nSupports both console session and customer client session authentication.',
|
|
44338
|
+
operationId: 'seamCustomerV1AutomationsUpdatePatch',
|
|
44339
|
+
requestBody: {
|
|
44340
|
+
content: {
|
|
44341
|
+
'application/json': {
|
|
44342
|
+
schema: {
|
|
44343
|
+
properties: {
|
|
44344
|
+
access_rules: {
|
|
44345
|
+
description: 'Access automation rules configuration.',
|
|
44346
|
+
properties: {
|
|
44347
|
+
reservation_created: {
|
|
44348
|
+
properties: {
|
|
44349
|
+
config: {
|
|
44350
|
+
properties: {
|
|
44351
|
+
access_methods: {
|
|
44352
|
+
items: {
|
|
44353
|
+
enum: ['card', 'mobile_key', 'code'],
|
|
44354
|
+
type: 'string',
|
|
44355
|
+
},
|
|
44356
|
+
minItems: 1,
|
|
44357
|
+
type: 'array',
|
|
44358
|
+
},
|
|
44359
|
+
method_issuance_strategy: {
|
|
44360
|
+
enum: [
|
|
44361
|
+
'first_available',
|
|
44362
|
+
'first_two_available',
|
|
44363
|
+
'all_available',
|
|
44364
|
+
],
|
|
44365
|
+
type: 'string',
|
|
44366
|
+
},
|
|
44367
|
+
},
|
|
44368
|
+
required: [
|
|
44369
|
+
'access_methods',
|
|
44370
|
+
'method_issuance_strategy',
|
|
44371
|
+
],
|
|
44372
|
+
type: 'object',
|
|
44373
|
+
},
|
|
44374
|
+
rule: {
|
|
44375
|
+
enum: ['reservation_created'],
|
|
44376
|
+
type: 'string',
|
|
44377
|
+
},
|
|
44378
|
+
},
|
|
44379
|
+
required: ['rule', 'config'],
|
|
44380
|
+
type: 'object',
|
|
44381
|
+
},
|
|
44382
|
+
reservation_deleted: {
|
|
44383
|
+
properties: {
|
|
44384
|
+
config: { properties: {}, type: 'object' },
|
|
44385
|
+
rule: {
|
|
44386
|
+
enum: ['reservation_deleted'],
|
|
44387
|
+
type: 'string',
|
|
44388
|
+
},
|
|
44389
|
+
},
|
|
44390
|
+
required: ['rule', 'config'],
|
|
44391
|
+
type: 'object',
|
|
44392
|
+
},
|
|
44393
|
+
reservation_time_updated: {
|
|
44394
|
+
properties: {
|
|
44395
|
+
config: { properties: {}, type: 'object' },
|
|
44396
|
+
rule: {
|
|
44397
|
+
enum: ['reservation_time_updated'],
|
|
44398
|
+
type: 'string',
|
|
44399
|
+
},
|
|
44400
|
+
},
|
|
44401
|
+
required: ['rule', 'config'],
|
|
44402
|
+
type: 'object',
|
|
44403
|
+
},
|
|
44404
|
+
},
|
|
44405
|
+
type: 'object',
|
|
44406
|
+
},
|
|
44407
|
+
},
|
|
44408
|
+
type: 'object',
|
|
44409
|
+
},
|
|
44410
|
+
},
|
|
44411
|
+
},
|
|
44412
|
+
},
|
|
44413
|
+
responses: {
|
|
44414
|
+
200: {
|
|
44415
|
+
content: {
|
|
44416
|
+
'application/json': {
|
|
44417
|
+
schema: {
|
|
44418
|
+
properties: { ok: { type: 'boolean' } },
|
|
44419
|
+
required: ['ok'],
|
|
44420
|
+
type: 'object',
|
|
44421
|
+
},
|
|
44422
|
+
},
|
|
44423
|
+
},
|
|
44424
|
+
description: 'OK',
|
|
44425
|
+
},
|
|
44426
|
+
400: { description: 'Bad Request' },
|
|
44427
|
+
401: { description: 'Unauthorized' },
|
|
44428
|
+
},
|
|
44429
|
+
security: [
|
|
44430
|
+
{ console_session_with_workspace: [] },
|
|
44431
|
+
{ api_key: [] },
|
|
44432
|
+
{ client_session_with_customer: [] },
|
|
44433
|
+
],
|
|
44434
|
+
summary: '/seam/customer/v1/automations/update',
|
|
44435
|
+
tags: [],
|
|
44436
|
+
'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'automations'],
|
|
44437
|
+
'x-fern-sdk-method-name': 'update',
|
|
44438
|
+
'x-response-key': null,
|
|
44439
|
+
'x-title': 'Update Customer Portal Automation Configuration',
|
|
44440
|
+
'x-undocumented': 'Internal endpoint for customer portals.',
|
|
44441
|
+
},
|
|
44442
|
+
post: {
|
|
44443
|
+
description:
|
|
44444
|
+
'Updates the automation configuration for a customer portal workspace.\nSupports both console session and customer client session authentication.',
|
|
44445
|
+
operationId: 'seamCustomerV1AutomationsUpdatePost',
|
|
44446
|
+
requestBody: {
|
|
44447
|
+
content: {
|
|
44448
|
+
'application/json': {
|
|
44449
|
+
schema: {
|
|
44450
|
+
properties: {
|
|
44451
|
+
access_rules: {
|
|
44452
|
+
description: 'Access automation rules configuration.',
|
|
44453
|
+
properties: {
|
|
44454
|
+
reservation_created: {
|
|
44455
|
+
properties: {
|
|
44456
|
+
config: {
|
|
44457
|
+
properties: {
|
|
44458
|
+
access_methods: {
|
|
44459
|
+
items: {
|
|
44460
|
+
enum: ['card', 'mobile_key', 'code'],
|
|
44461
|
+
type: 'string',
|
|
44462
|
+
},
|
|
44463
|
+
minItems: 1,
|
|
44464
|
+
type: 'array',
|
|
44465
|
+
},
|
|
44466
|
+
method_issuance_strategy: {
|
|
44467
|
+
enum: [
|
|
44468
|
+
'first_available',
|
|
44469
|
+
'first_two_available',
|
|
44470
|
+
'all_available',
|
|
44471
|
+
],
|
|
44472
|
+
type: 'string',
|
|
44473
|
+
},
|
|
44474
|
+
},
|
|
44475
|
+
required: [
|
|
44476
|
+
'access_methods',
|
|
44477
|
+
'method_issuance_strategy',
|
|
44478
|
+
],
|
|
44479
|
+
type: 'object',
|
|
44480
|
+
},
|
|
44481
|
+
rule: {
|
|
44482
|
+
enum: ['reservation_created'],
|
|
44483
|
+
type: 'string',
|
|
44484
|
+
},
|
|
44485
|
+
},
|
|
44486
|
+
required: ['rule', 'config'],
|
|
44487
|
+
type: 'object',
|
|
44488
|
+
},
|
|
44489
|
+
reservation_deleted: {
|
|
44490
|
+
properties: {
|
|
44491
|
+
config: { properties: {}, type: 'object' },
|
|
44492
|
+
rule: {
|
|
44493
|
+
enum: ['reservation_deleted'],
|
|
44494
|
+
type: 'string',
|
|
44495
|
+
},
|
|
44496
|
+
},
|
|
44497
|
+
required: ['rule', 'config'],
|
|
44498
|
+
type: 'object',
|
|
44499
|
+
},
|
|
44500
|
+
reservation_time_updated: {
|
|
44501
|
+
properties: {
|
|
44502
|
+
config: { properties: {}, type: 'object' },
|
|
44503
|
+
rule: {
|
|
44504
|
+
enum: ['reservation_time_updated'],
|
|
44505
|
+
type: 'string',
|
|
44506
|
+
},
|
|
44507
|
+
},
|
|
44508
|
+
required: ['rule', 'config'],
|
|
44509
|
+
type: 'object',
|
|
44510
|
+
},
|
|
44511
|
+
},
|
|
44512
|
+
type: 'object',
|
|
44513
|
+
},
|
|
44514
|
+
},
|
|
44515
|
+
type: 'object',
|
|
44516
|
+
},
|
|
44517
|
+
},
|
|
44518
|
+
},
|
|
44519
|
+
},
|
|
44520
|
+
responses: {
|
|
44521
|
+
200: {
|
|
44522
|
+
content: {
|
|
44523
|
+
'application/json': {
|
|
44524
|
+
schema: {
|
|
44525
|
+
properties: { ok: { type: 'boolean' } },
|
|
44526
|
+
required: ['ok'],
|
|
44527
|
+
type: 'object',
|
|
44528
|
+
},
|
|
44529
|
+
},
|
|
44530
|
+
},
|
|
44531
|
+
description: 'OK',
|
|
44532
|
+
},
|
|
44533
|
+
400: { description: 'Bad Request' },
|
|
44534
|
+
401: { description: 'Unauthorized' },
|
|
44535
|
+
},
|
|
44536
|
+
security: [
|
|
44537
|
+
{ console_session_with_workspace: [] },
|
|
44538
|
+
{ api_key: [] },
|
|
44539
|
+
{ client_session_with_customer: [] },
|
|
44540
|
+
],
|
|
44541
|
+
summary: '/seam/customer/v1/automations/update',
|
|
44542
|
+
tags: [],
|
|
44543
|
+
'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'automations'],
|
|
44544
|
+
'x-fern-sdk-method-name': 'update',
|
|
44545
|
+
'x-response-key': null,
|
|
44546
|
+
'x-title': 'Update Customer Portal Automation Configuration',
|
|
44547
|
+
'x-undocumented': 'Internal endpoint for customer portals.',
|
|
44548
|
+
},
|
|
44549
|
+
},
|
|
44109
44550
|
'/seam/customer/v1/portals/get': {
|
|
44110
44551
|
get: {
|
|
44111
44552
|
description:
|