@seamapi/types 1.1087.0 → 1.1089.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.
|
@@ -42279,7 +42279,7 @@ const openapi = {
|
|
|
42279
42279
|
type: 'string',
|
|
42280
42280
|
},
|
|
42281
42281
|
user_identifier_key: {
|
|
42282
|
-
description: 'Your user ID for the user for whom you want to create a client session.',
|
|
42282
|
+
description: 'Your user ID for the user for whom you want to create a client session. When you authenticate with a publishable key, the `user_identifier_key` must be a high-entropy secret that only the user knows, such as a UUIDv4 or a salted hash. Do not use an email address, name, phone number, or other guessable value, because anyone who knows the `user_identifier_key` can retrieve the client session.',
|
|
42283
42283
|
minLength: 1,
|
|
42284
42284
|
type: 'string',
|
|
42285
42285
|
},
|
|
@@ -42469,7 +42469,7 @@ const openapi = {
|
|
|
42469
42469
|
type: 'string',
|
|
42470
42470
|
},
|
|
42471
42471
|
user_identifier_key: {
|
|
42472
|
-
description: 'Your user ID for the user that you want to associate with the client session (or that is already associated with the existing client session).',
|
|
42472
|
+
description: 'Your user ID for the user that you want to associate with the client session (or that is already associated with the existing client session). When you authenticate with a publishable key, the `user_identifier_key` must be a high-entropy secret that only the user knows, such as a UUIDv4 or a salted hash. Do not use an email address, name, phone number, or other guessable value, because anyone who knows the `user_identifier_key` can retrieve the client session.',
|
|
42473
42473
|
minLength: 1,
|
|
42474
42474
|
type: 'string',
|
|
42475
42475
|
},
|
|
@@ -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.',
|