@seamapi/types 1.1086.0 → 1.1088.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.
|
@@ -54238,6 +54238,116 @@ const openapi = {
|
|
|
54238
54238
|
'x-undocumented': 'Internal endpoint for customer portals.',
|
|
54239
54239
|
},
|
|
54240
54240
|
},
|
|
54241
|
+
'/seam/customer/v1/automation_runs/create': {
|
|
54242
|
+
post: {
|
|
54243
|
+
description: "Runs automations for a reservation now instead of waiting for the next connector sync. Use it after deleting a reservation's access grant to issue a new one.",
|
|
54244
|
+
operationId: 'seamCustomerV1AutomationRunsCreatePost',
|
|
54245
|
+
requestBody: {
|
|
54246
|
+
content: {
|
|
54247
|
+
'application/json': {
|
|
54248
|
+
schema: {
|
|
54249
|
+
properties: {
|
|
54250
|
+
customer_key: {
|
|
54251
|
+
description: 'Key of the customer that owns the reservation. Not allowed with client_session_with_customer auth.',
|
|
54252
|
+
minLength: 1,
|
|
54253
|
+
type: 'string',
|
|
54254
|
+
},
|
|
54255
|
+
reservation_key: {
|
|
54256
|
+
description: 'Key of the reservation to run automations for.',
|
|
54257
|
+
minLength: 1,
|
|
54258
|
+
type: 'string',
|
|
54259
|
+
},
|
|
54260
|
+
should_ignore_guest_phone_last4_as_code: {
|
|
54261
|
+
default: false,
|
|
54262
|
+
description: "Don't use the last four digits of the guest's phone number as the new access grant's code, even when the automation is configured to.",
|
|
54263
|
+
type: 'boolean',
|
|
54264
|
+
},
|
|
54265
|
+
should_ignore_preferred_code: {
|
|
54266
|
+
default: false,
|
|
54267
|
+
description: "Don't use the reservation's preferred code for the new access grant's code.",
|
|
54268
|
+
type: 'boolean',
|
|
54269
|
+
},
|
|
54270
|
+
},
|
|
54271
|
+
required: ['reservation_key'],
|
|
54272
|
+
type: 'object',
|
|
54273
|
+
},
|
|
54274
|
+
},
|
|
54275
|
+
},
|
|
54276
|
+
},
|
|
54277
|
+
responses: {
|
|
54278
|
+
'200': {
|
|
54279
|
+
content: {
|
|
54280
|
+
'application/json': {
|
|
54281
|
+
schema: {
|
|
54282
|
+
properties: {
|
|
54283
|
+
automation_run: {
|
|
54284
|
+
properties: {
|
|
54285
|
+
access_grant_id: {
|
|
54286
|
+
description: 'ID of the access grant the run created.',
|
|
54287
|
+
format: 'uuid',
|
|
54288
|
+
nullable: true,
|
|
54289
|
+
type: 'string',
|
|
54290
|
+
},
|
|
54291
|
+
message: { nullable: true, type: 'string' },
|
|
54292
|
+
reservation_id: { format: 'uuid', type: 'string' },
|
|
54293
|
+
reservation_key: { type: 'string' },
|
|
54294
|
+
reused_code_source: {
|
|
54295
|
+
description: "Set when the new access grant's code is fixed by the reservation instead of generated, so it matches the previous code. `reservation_preferred_code` means the reservation sets a preferred code; `guest_phone_number` means the automation uses the last digits of the guest's phone number.",
|
|
54296
|
+
enum: [
|
|
54297
|
+
'reservation_preferred_code',
|
|
54298
|
+
'guest_phone_number',
|
|
54299
|
+
],
|
|
54300
|
+
nullable: true,
|
|
54301
|
+
type: 'string',
|
|
54302
|
+
},
|
|
54303
|
+
skip_reason: {
|
|
54304
|
+
description: 'Why the run did not create an access grant.',
|
|
54305
|
+
nullable: true,
|
|
54306
|
+
type: 'string',
|
|
54307
|
+
},
|
|
54308
|
+
status: {
|
|
54309
|
+
enum: ['access_grant_created', 'skipped'],
|
|
54310
|
+
type: 'string',
|
|
54311
|
+
},
|
|
54312
|
+
},
|
|
54313
|
+
required: [
|
|
54314
|
+
'status',
|
|
54315
|
+
'reservation_id',
|
|
54316
|
+
'reservation_key',
|
|
54317
|
+
'access_grant_id',
|
|
54318
|
+
'skip_reason',
|
|
54319
|
+
'message',
|
|
54320
|
+
'reused_code_source',
|
|
54321
|
+
],
|
|
54322
|
+
type: 'object',
|
|
54323
|
+
},
|
|
54324
|
+
ok: { type: 'boolean' },
|
|
54325
|
+
},
|
|
54326
|
+
required: ['automation_run', 'ok'],
|
|
54327
|
+
type: 'object',
|
|
54328
|
+
},
|
|
54329
|
+
},
|
|
54330
|
+
},
|
|
54331
|
+
description: 'OK',
|
|
54332
|
+
},
|
|
54333
|
+
'400': { description: 'Bad Request' },
|
|
54334
|
+
'401': { description: 'Unauthorized' },
|
|
54335
|
+
},
|
|
54336
|
+
security: [
|
|
54337
|
+
{ client_session_with_customer: [] },
|
|
54338
|
+
{ console_session_with_workspace: [] },
|
|
54339
|
+
{ api_key: [] },
|
|
54340
|
+
],
|
|
54341
|
+
summary: '/seam/customer/v1/automation_runs/create',
|
|
54342
|
+
tags: [],
|
|
54343
|
+
'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'automation_runs'],
|
|
54344
|
+
'x-fern-sdk-method-name': 'create',
|
|
54345
|
+
'x-fern-sdk-return-value': 'automation_run',
|
|
54346
|
+
'x-response-key': 'automation_run',
|
|
54347
|
+
'x-title': 'Create Automation Run',
|
|
54348
|
+
'x-undocumented': 'Internal endpoint for customer portals.',
|
|
54349
|
+
},
|
|
54350
|
+
},
|
|
54241
54351
|
'/seam/customer/v1/automation_runs/list': {
|
|
54242
54352
|
get: {
|
|
54243
54353
|
description: 'Returns a list of all automation runs for a workspace or customer.',
|
|
@@ -54486,6 +54596,11 @@ const openapi = {
|
|
|
54486
54596
|
properties: {
|
|
54487
54597
|
config: {
|
|
54488
54598
|
properties: {
|
|
54599
|
+
access_ends_minutes_after_reservation: {
|
|
54600
|
+
maximum: 1440,
|
|
54601
|
+
minimum: 0,
|
|
54602
|
+
type: 'integer',
|
|
54603
|
+
},
|
|
54489
54604
|
access_methods: {
|
|
54490
54605
|
items: {
|
|
54491
54606
|
enum: ['card', 'mobile_key', 'code'],
|
|
@@ -54494,6 +54609,11 @@ const openapi = {
|
|
|
54494
54609
|
minItems: 1,
|
|
54495
54610
|
type: 'array',
|
|
54496
54611
|
},
|
|
54612
|
+
access_starts_minutes_before_reservation: {
|
|
54613
|
+
maximum: 1440,
|
|
54614
|
+
minimum: 0,
|
|
54615
|
+
type: 'integer',
|
|
54616
|
+
},
|
|
54497
54617
|
allow_shared_email_and_phone_across_user_identities: { type: 'boolean' },
|
|
54498
54618
|
card_count_on_reservation_create: {
|
|
54499
54619
|
minimum: 0,
|
|
@@ -54770,6 +54890,11 @@ const openapi = {
|
|
|
54770
54890
|
properties: {
|
|
54771
54891
|
config: {
|
|
54772
54892
|
properties: {
|
|
54893
|
+
access_ends_minutes_after_reservation: {
|
|
54894
|
+
maximum: 1440,
|
|
54895
|
+
minimum: 0,
|
|
54896
|
+
type: 'integer',
|
|
54897
|
+
},
|
|
54773
54898
|
access_methods: {
|
|
54774
54899
|
items: {
|
|
54775
54900
|
enum: ['card', 'mobile_key', 'code'],
|
|
@@ -54778,6 +54903,11 @@ const openapi = {
|
|
|
54778
54903
|
minItems: 1,
|
|
54779
54904
|
type: 'array',
|
|
54780
54905
|
},
|
|
54906
|
+
access_starts_minutes_before_reservation: {
|
|
54907
|
+
maximum: 1440,
|
|
54908
|
+
minimum: 0,
|
|
54909
|
+
type: 'integer',
|
|
54910
|
+
},
|
|
54781
54911
|
allow_shared_email_and_phone_across_user_identities: { type: 'boolean' },
|
|
54782
54912
|
card_count_on_reservation_create: {
|
|
54783
54913
|
minimum: 0,
|
|
@@ -56038,6 +56168,11 @@ const openapi = {
|
|
|
56038
56168
|
properties: {
|
|
56039
56169
|
config: {
|
|
56040
56170
|
properties: {
|
|
56171
|
+
access_ends_minutes_after_reservation: {
|
|
56172
|
+
maximum: 1440,
|
|
56173
|
+
minimum: 0,
|
|
56174
|
+
type: 'integer',
|
|
56175
|
+
},
|
|
56041
56176
|
access_methods: {
|
|
56042
56177
|
items: {
|
|
56043
56178
|
enum: ['card', 'mobile_key', 'code'],
|
|
@@ -56046,6 +56181,11 @@ const openapi = {
|
|
|
56046
56181
|
minItems: 1,
|
|
56047
56182
|
type: 'array',
|
|
56048
56183
|
},
|
|
56184
|
+
access_starts_minutes_before_reservation: {
|
|
56185
|
+
maximum: 1440,
|
|
56186
|
+
minimum: 0,
|
|
56187
|
+
type: 'integer',
|
|
56188
|
+
},
|
|
56049
56189
|
allow_shared_email_and_phone_across_user_identities: { type: 'boolean' },
|
|
56050
56190
|
card_count_on_reservation_create: {
|
|
56051
56191
|
minimum: 0,
|
|
@@ -56339,6 +56479,11 @@ const openapi = {
|
|
|
56339
56479
|
properties: {
|
|
56340
56480
|
config: {
|
|
56341
56481
|
properties: {
|
|
56482
|
+
access_ends_minutes_after_reservation: {
|
|
56483
|
+
maximum: 1440,
|
|
56484
|
+
minimum: 0,
|
|
56485
|
+
type: 'integer',
|
|
56486
|
+
},
|
|
56342
56487
|
access_methods: {
|
|
56343
56488
|
items: {
|
|
56344
56489
|
enum: ['card', 'mobile_key', 'code'],
|
|
@@ -56347,6 +56492,11 @@ const openapi = {
|
|
|
56347
56492
|
minItems: 1,
|
|
56348
56493
|
type: 'array',
|
|
56349
56494
|
},
|
|
56495
|
+
access_starts_minutes_before_reservation: {
|
|
56496
|
+
maximum: 1440,
|
|
56497
|
+
minimum: 0,
|
|
56498
|
+
type: 'integer',
|
|
56499
|
+
},
|
|
56350
56500
|
allow_shared_email_and_phone_across_user_identities: { type: 'boolean' },
|
|
56351
56501
|
card_count_on_reservation_create: {
|
|
56352
56502
|
minimum: 0,
|