@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.
|
@@ -83761,6 +83761,38 @@ export type Routes = {
|
|
|
83761
83761
|
};
|
|
83762
83762
|
maxDuration: undefined;
|
|
83763
83763
|
};
|
|
83764
|
+
'/seam/customer/v1/automation_runs/create': {
|
|
83765
|
+
route: '/seam/customer/v1/automation_runs/create';
|
|
83766
|
+
method: 'POST';
|
|
83767
|
+
queryParams: {};
|
|
83768
|
+
jsonBody: {
|
|
83769
|
+
/** Key of the customer that owns the reservation. Not allowed with client_session_with_customer auth. */
|
|
83770
|
+
customer_key?: string | undefined;
|
|
83771
|
+
/** Key of the reservation to run automations for. */
|
|
83772
|
+
reservation_key: string;
|
|
83773
|
+
/** Don't use the reservation's preferred code for the new access grant's code. */
|
|
83774
|
+
should_ignore_preferred_code?: boolean;
|
|
83775
|
+
/** 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. */
|
|
83776
|
+
should_ignore_guest_phone_last4_as_code?: boolean;
|
|
83777
|
+
};
|
|
83778
|
+
commonParams: {};
|
|
83779
|
+
formData: {};
|
|
83780
|
+
jsonResponse: {
|
|
83781
|
+
automation_run: {
|
|
83782
|
+
status: 'access_grant_created' | 'skipped';
|
|
83783
|
+
reservation_id: string;
|
|
83784
|
+
reservation_key: string;
|
|
83785
|
+
/** ID of the access grant the run created. */
|
|
83786
|
+
access_grant_id: string | null;
|
|
83787
|
+
/** Why the run did not create an access grant. */
|
|
83788
|
+
skip_reason: string | null;
|
|
83789
|
+
message: string | null;
|
|
83790
|
+
/** 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. */
|
|
83791
|
+
reused_code_source: ('reservation_preferred_code' | 'guest_phone_number') | null;
|
|
83792
|
+
};
|
|
83793
|
+
};
|
|
83794
|
+
maxDuration: undefined;
|
|
83795
|
+
};
|
|
83764
83796
|
'/seam/customer/v1/automation_runs/list': {
|
|
83765
83797
|
route: '/seam/customer/v1/automation_runs/list';
|
|
83766
83798
|
method: 'GET' | 'POST';
|
|
@@ -83848,6 +83880,8 @@ export type Routes = {
|
|
|
83848
83880
|
instant_key_max_use_count?: number | undefined;
|
|
83849
83881
|
prefer_guest_phone_last4_as_code?: boolean | undefined;
|
|
83850
83882
|
allow_shared_email_and_phone_across_user_identities?: boolean | undefined;
|
|
83883
|
+
access_starts_minutes_before_reservation?: number | undefined;
|
|
83884
|
+
access_ends_minutes_after_reservation?: number | undefined;
|
|
83851
83885
|
};
|
|
83852
83886
|
} | undefined;
|
|
83853
83887
|
reservation_time_updated?: {
|
|
@@ -83931,6 +83965,8 @@ export type Routes = {
|
|
|
83931
83965
|
instant_key_max_use_count?: number | undefined;
|
|
83932
83966
|
prefer_guest_phone_last4_as_code?: boolean | undefined;
|
|
83933
83967
|
allow_shared_email_and_phone_across_user_identities?: boolean | undefined;
|
|
83968
|
+
access_starts_minutes_before_reservation?: number | undefined;
|
|
83969
|
+
access_ends_minutes_after_reservation?: number | undefined;
|
|
83934
83970
|
};
|
|
83935
83971
|
} | null) | undefined;
|
|
83936
83972
|
reservation_time_updated?: ({
|
|
@@ -84341,6 +84377,8 @@ export type Routes = {
|
|
|
84341
84377
|
instant_key_max_use_count?: number | undefined;
|
|
84342
84378
|
prefer_guest_phone_last4_as_code?: boolean | undefined;
|
|
84343
84379
|
allow_shared_email_and_phone_across_user_identities?: boolean | undefined;
|
|
84380
|
+
access_starts_minutes_before_reservation?: number | undefined;
|
|
84381
|
+
access_ends_minutes_after_reservation?: number | undefined;
|
|
84344
84382
|
};
|
|
84345
84383
|
} | undefined;
|
|
84346
84384
|
reservation_time_updated?: {
|
|
@@ -84423,6 +84461,8 @@ export type Routes = {
|
|
|
84423
84461
|
instant_key_max_use_count?: number | undefined;
|
|
84424
84462
|
prefer_guest_phone_last4_as_code?: boolean | undefined;
|
|
84425
84463
|
allow_shared_email_and_phone_across_user_identities?: boolean | undefined;
|
|
84464
|
+
access_starts_minutes_before_reservation?: number | undefined;
|
|
84465
|
+
access_ends_minutes_after_reservation?: number | undefined;
|
|
84426
84466
|
};
|
|
84427
84467
|
} | null) | undefined;
|
|
84428
84468
|
reservation_time_updated?: ({
|
package/package.json
CHANGED
|
@@ -59391,6 +59391,124 @@ const openapi: OpenAPISpec = {
|
|
|
59391
59391
|
'x-undocumented': 'Internal endpoint for customer portals.',
|
|
59392
59392
|
},
|
|
59393
59393
|
},
|
|
59394
|
+
'/seam/customer/v1/automation_runs/create': {
|
|
59395
|
+
post: {
|
|
59396
|
+
description:
|
|
59397
|
+
"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.",
|
|
59398
|
+
operationId: 'seamCustomerV1AutomationRunsCreatePost',
|
|
59399
|
+
requestBody: {
|
|
59400
|
+
content: {
|
|
59401
|
+
'application/json': {
|
|
59402
|
+
schema: {
|
|
59403
|
+
properties: {
|
|
59404
|
+
customer_key: {
|
|
59405
|
+
description:
|
|
59406
|
+
'Key of the customer that owns the reservation. Not allowed with client_session_with_customer auth.',
|
|
59407
|
+
minLength: 1,
|
|
59408
|
+
type: 'string',
|
|
59409
|
+
},
|
|
59410
|
+
reservation_key: {
|
|
59411
|
+
description:
|
|
59412
|
+
'Key of the reservation to run automations for.',
|
|
59413
|
+
minLength: 1,
|
|
59414
|
+
type: 'string',
|
|
59415
|
+
},
|
|
59416
|
+
should_ignore_guest_phone_last4_as_code: {
|
|
59417
|
+
default: false,
|
|
59418
|
+
description:
|
|
59419
|
+
"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.",
|
|
59420
|
+
type: 'boolean',
|
|
59421
|
+
},
|
|
59422
|
+
should_ignore_preferred_code: {
|
|
59423
|
+
default: false,
|
|
59424
|
+
description:
|
|
59425
|
+
"Don't use the reservation's preferred code for the new access grant's code.",
|
|
59426
|
+
type: 'boolean',
|
|
59427
|
+
},
|
|
59428
|
+
},
|
|
59429
|
+
required: ['reservation_key'],
|
|
59430
|
+
type: 'object',
|
|
59431
|
+
},
|
|
59432
|
+
},
|
|
59433
|
+
},
|
|
59434
|
+
},
|
|
59435
|
+
responses: {
|
|
59436
|
+
'200': {
|
|
59437
|
+
content: {
|
|
59438
|
+
'application/json': {
|
|
59439
|
+
schema: {
|
|
59440
|
+
properties: {
|
|
59441
|
+
automation_run: {
|
|
59442
|
+
properties: {
|
|
59443
|
+
access_grant_id: {
|
|
59444
|
+
description:
|
|
59445
|
+
'ID of the access grant the run created.',
|
|
59446
|
+
format: 'uuid',
|
|
59447
|
+
nullable: true,
|
|
59448
|
+
type: 'string',
|
|
59449
|
+
},
|
|
59450
|
+
message: { nullable: true, type: 'string' },
|
|
59451
|
+
reservation_id: { format: 'uuid', type: 'string' },
|
|
59452
|
+
reservation_key: { type: 'string' },
|
|
59453
|
+
reused_code_source: {
|
|
59454
|
+
description:
|
|
59455
|
+
"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.",
|
|
59456
|
+
enum: [
|
|
59457
|
+
'reservation_preferred_code',
|
|
59458
|
+
'guest_phone_number',
|
|
59459
|
+
],
|
|
59460
|
+
nullable: true,
|
|
59461
|
+
type: 'string',
|
|
59462
|
+
},
|
|
59463
|
+
skip_reason: {
|
|
59464
|
+
description:
|
|
59465
|
+
'Why the run did not create an access grant.',
|
|
59466
|
+
nullable: true,
|
|
59467
|
+
type: 'string',
|
|
59468
|
+
},
|
|
59469
|
+
status: {
|
|
59470
|
+
enum: ['access_grant_created', 'skipped'],
|
|
59471
|
+
type: 'string',
|
|
59472
|
+
},
|
|
59473
|
+
},
|
|
59474
|
+
required: [
|
|
59475
|
+
'status',
|
|
59476
|
+
'reservation_id',
|
|
59477
|
+
'reservation_key',
|
|
59478
|
+
'access_grant_id',
|
|
59479
|
+
'skip_reason',
|
|
59480
|
+
'message',
|
|
59481
|
+
'reused_code_source',
|
|
59482
|
+
],
|
|
59483
|
+
type: 'object',
|
|
59484
|
+
},
|
|
59485
|
+
ok: { type: 'boolean' },
|
|
59486
|
+
},
|
|
59487
|
+
required: ['automation_run', 'ok'],
|
|
59488
|
+
type: 'object',
|
|
59489
|
+
},
|
|
59490
|
+
},
|
|
59491
|
+
},
|
|
59492
|
+
description: 'OK',
|
|
59493
|
+
},
|
|
59494
|
+
'400': { description: 'Bad Request' },
|
|
59495
|
+
'401': { description: 'Unauthorized' },
|
|
59496
|
+
},
|
|
59497
|
+
security: [
|
|
59498
|
+
{ client_session_with_customer: [] },
|
|
59499
|
+
{ console_session_with_workspace: [] },
|
|
59500
|
+
{ api_key: [] },
|
|
59501
|
+
],
|
|
59502
|
+
summary: '/seam/customer/v1/automation_runs/create',
|
|
59503
|
+
tags: [],
|
|
59504
|
+
'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'automation_runs'],
|
|
59505
|
+
'x-fern-sdk-method-name': 'create',
|
|
59506
|
+
'x-fern-sdk-return-value': 'automation_run',
|
|
59507
|
+
'x-response-key': 'automation_run',
|
|
59508
|
+
'x-title': 'Create Automation Run',
|
|
59509
|
+
'x-undocumented': 'Internal endpoint for customer portals.',
|
|
59510
|
+
},
|
|
59511
|
+
},
|
|
59394
59512
|
'/seam/customer/v1/automation_runs/list': {
|
|
59395
59513
|
get: {
|
|
59396
59514
|
description:
|
|
@@ -59647,6 +59765,11 @@ const openapi: OpenAPISpec = {
|
|
|
59647
59765
|
properties: {
|
|
59648
59766
|
config: {
|
|
59649
59767
|
properties: {
|
|
59768
|
+
access_ends_minutes_after_reservation: {
|
|
59769
|
+
maximum: 1440,
|
|
59770
|
+
minimum: 0,
|
|
59771
|
+
type: 'integer',
|
|
59772
|
+
},
|
|
59650
59773
|
access_methods: {
|
|
59651
59774
|
items: {
|
|
59652
59775
|
enum: ['card', 'mobile_key', 'code'],
|
|
@@ -59655,6 +59778,11 @@ const openapi: OpenAPISpec = {
|
|
|
59655
59778
|
minItems: 1,
|
|
59656
59779
|
type: 'array',
|
|
59657
59780
|
},
|
|
59781
|
+
access_starts_minutes_before_reservation: {
|
|
59782
|
+
maximum: 1440,
|
|
59783
|
+
minimum: 0,
|
|
59784
|
+
type: 'integer',
|
|
59785
|
+
},
|
|
59658
59786
|
allow_shared_email_and_phone_across_user_identities:
|
|
59659
59787
|
{ type: 'boolean' },
|
|
59660
59788
|
card_count_on_reservation_create: {
|
|
@@ -59933,6 +60061,11 @@ const openapi: OpenAPISpec = {
|
|
|
59933
60061
|
properties: {
|
|
59934
60062
|
config: {
|
|
59935
60063
|
properties: {
|
|
60064
|
+
access_ends_minutes_after_reservation: {
|
|
60065
|
+
maximum: 1440,
|
|
60066
|
+
minimum: 0,
|
|
60067
|
+
type: 'integer',
|
|
60068
|
+
},
|
|
59936
60069
|
access_methods: {
|
|
59937
60070
|
items: {
|
|
59938
60071
|
enum: ['card', 'mobile_key', 'code'],
|
|
@@ -59941,6 +60074,11 @@ const openapi: OpenAPISpec = {
|
|
|
59941
60074
|
minItems: 1,
|
|
59942
60075
|
type: 'array',
|
|
59943
60076
|
},
|
|
60077
|
+
access_starts_minutes_before_reservation: {
|
|
60078
|
+
maximum: 1440,
|
|
60079
|
+
minimum: 0,
|
|
60080
|
+
type: 'integer',
|
|
60081
|
+
},
|
|
59944
60082
|
allow_shared_email_and_phone_across_user_identities:
|
|
59945
60083
|
{ type: 'boolean' },
|
|
59946
60084
|
card_count_on_reservation_create: {
|
|
@@ -61240,6 +61378,11 @@ const openapi: OpenAPISpec = {
|
|
|
61240
61378
|
properties: {
|
|
61241
61379
|
config: {
|
|
61242
61380
|
properties: {
|
|
61381
|
+
access_ends_minutes_after_reservation: {
|
|
61382
|
+
maximum: 1440,
|
|
61383
|
+
minimum: 0,
|
|
61384
|
+
type: 'integer',
|
|
61385
|
+
},
|
|
61243
61386
|
access_methods: {
|
|
61244
61387
|
items: {
|
|
61245
61388
|
enum: ['card', 'mobile_key', 'code'],
|
|
@@ -61248,6 +61391,11 @@ const openapi: OpenAPISpec = {
|
|
|
61248
61391
|
minItems: 1,
|
|
61249
61392
|
type: 'array',
|
|
61250
61393
|
},
|
|
61394
|
+
access_starts_minutes_before_reservation: {
|
|
61395
|
+
maximum: 1440,
|
|
61396
|
+
minimum: 0,
|
|
61397
|
+
type: 'integer',
|
|
61398
|
+
},
|
|
61251
61399
|
allow_shared_email_and_phone_across_user_identities:
|
|
61252
61400
|
{ type: 'boolean' },
|
|
61253
61401
|
card_count_on_reservation_create: {
|
|
@@ -61543,6 +61691,11 @@ const openapi: OpenAPISpec = {
|
|
|
61543
61691
|
properties: {
|
|
61544
61692
|
config: {
|
|
61545
61693
|
properties: {
|
|
61694
|
+
access_ends_minutes_after_reservation: {
|
|
61695
|
+
maximum: 1440,
|
|
61696
|
+
minimum: 0,
|
|
61697
|
+
type: 'integer',
|
|
61698
|
+
},
|
|
61546
61699
|
access_methods: {
|
|
61547
61700
|
items: {
|
|
61548
61701
|
enum: ['card', 'mobile_key', 'code'],
|
|
@@ -61551,6 +61704,11 @@ const openapi: OpenAPISpec = {
|
|
|
61551
61704
|
minItems: 1,
|
|
61552
61705
|
type: 'array',
|
|
61553
61706
|
},
|
|
61707
|
+
access_starts_minutes_before_reservation: {
|
|
61708
|
+
maximum: 1440,
|
|
61709
|
+
minimum: 0,
|
|
61710
|
+
type: 'integer',
|
|
61711
|
+
},
|
|
61554
61712
|
allow_shared_email_and_phone_across_user_identities:
|
|
61555
61713
|
{ type: 'boolean' },
|
|
61556
61714
|
card_count_on_reservation_create: {
|
|
@@ -100521,6 +100521,39 @@ export type Routes = {
|
|
|
100521
100521
|
}
|
|
100522
100522
|
maxDuration: undefined
|
|
100523
100523
|
}
|
|
100524
|
+
'/seam/customer/v1/automation_runs/create': {
|
|
100525
|
+
route: '/seam/customer/v1/automation_runs/create'
|
|
100526
|
+
method: 'POST'
|
|
100527
|
+
queryParams: {}
|
|
100528
|
+
jsonBody: {
|
|
100529
|
+
/** Key of the customer that owns the reservation. Not allowed with client_session_with_customer auth. */
|
|
100530
|
+
customer_key?: string | undefined
|
|
100531
|
+
/** Key of the reservation to run automations for. */
|
|
100532
|
+
reservation_key: string
|
|
100533
|
+
/** Don't use the reservation's preferred code for the new access grant's code. */
|
|
100534
|
+
should_ignore_preferred_code?: boolean
|
|
100535
|
+
/** 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. */
|
|
100536
|
+
should_ignore_guest_phone_last4_as_code?: boolean
|
|
100537
|
+
}
|
|
100538
|
+
commonParams: {}
|
|
100539
|
+
formData: {}
|
|
100540
|
+
jsonResponse: {
|
|
100541
|
+
automation_run: {
|
|
100542
|
+
status: 'access_grant_created' | 'skipped'
|
|
100543
|
+
reservation_id: string
|
|
100544
|
+
reservation_key: string
|
|
100545
|
+
/** ID of the access grant the run created. */
|
|
100546
|
+
access_grant_id: string | null
|
|
100547
|
+
/** Why the run did not create an access grant. */
|
|
100548
|
+
skip_reason: string | null
|
|
100549
|
+
message: string | null
|
|
100550
|
+
/** 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. */
|
|
100551
|
+
reused_code_source:
|
|
100552
|
+
('reservation_preferred_code' | 'guest_phone_number') | null
|
|
100553
|
+
}
|
|
100554
|
+
}
|
|
100555
|
+
maxDuration: undefined
|
|
100556
|
+
}
|
|
100524
100557
|
'/seam/customer/v1/automation_runs/list': {
|
|
100525
100558
|
route: '/seam/customer/v1/automation_runs/list'
|
|
100526
100559
|
method: 'GET' | 'POST'
|
|
@@ -100626,6 +100659,9 @@ export type Routes = {
|
|
|
100626
100659
|
prefer_guest_phone_last4_as_code?: boolean | undefined
|
|
100627
100660
|
allow_shared_email_and_phone_across_user_identities?:
|
|
100628
100661
|
boolean | undefined
|
|
100662
|
+
access_starts_minutes_before_reservation?:
|
|
100663
|
+
number | undefined
|
|
100664
|
+
access_ends_minutes_after_reservation?: number | undefined
|
|
100629
100665
|
}
|
|
100630
100666
|
}
|
|
100631
100667
|
| undefined
|
|
@@ -100739,6 +100775,9 @@ export type Routes = {
|
|
|
100739
100775
|
prefer_guest_phone_last4_as_code?: boolean | undefined
|
|
100740
100776
|
allow_shared_email_and_phone_across_user_identities?:
|
|
100741
100777
|
boolean | undefined
|
|
100778
|
+
access_starts_minutes_before_reservation?:
|
|
100779
|
+
number | undefined
|
|
100780
|
+
access_ends_minutes_after_reservation?: number | undefined
|
|
100742
100781
|
}
|
|
100743
100782
|
} | null)
|
|
100744
100783
|
| undefined
|
|
@@ -101207,6 +101246,9 @@ export type Routes = {
|
|
|
101207
101246
|
prefer_guest_phone_last4_as_code?: boolean | undefined
|
|
101208
101247
|
allow_shared_email_and_phone_across_user_identities?:
|
|
101209
101248
|
boolean | undefined
|
|
101249
|
+
access_starts_minutes_before_reservation?:
|
|
101250
|
+
number | undefined
|
|
101251
|
+
access_ends_minutes_after_reservation?: number | undefined
|
|
101210
101252
|
}
|
|
101211
101253
|
}
|
|
101212
101254
|
| undefined
|
|
@@ -101320,6 +101362,9 @@ export type Routes = {
|
|
|
101320
101362
|
prefer_guest_phone_last4_as_code?: boolean | undefined
|
|
101321
101363
|
allow_shared_email_and_phone_across_user_identities?:
|
|
101322
101364
|
boolean | undefined
|
|
101365
|
+
access_starts_minutes_before_reservation?:
|
|
101366
|
+
number | undefined
|
|
101367
|
+
access_ends_minutes_after_reservation?: number | undefined
|
|
101323
101368
|
}
|
|
101324
101369
|
} | null)
|
|
101325
101370
|
| undefined
|