@seamapi/types 1.749.0 → 1.751.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 CHANGED
@@ -3469,6 +3469,9 @@ var acs_entrance_capability_flags = zod.z.object({
3469
3469
  ),
3470
3470
  can_belong_to_reservation: zod.z.boolean().optional().describe(
3471
3471
  "Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key."
3472
+ ),
3473
+ can_unlock_with_cloud_key: zod.z.boolean().optional().describe(
3474
+ "Indicates whether the ACS entrance can be remotely unlocked using a cloud_key credential."
3472
3475
  )
3473
3476
  });
3474
3477
  var acs_entrance = zod.z.object({
@@ -9960,6 +9963,10 @@ var openapi_default = {
9960
9963
  description: "Indicates whether the ACS entrance can be unlocked with card credentials.",
9961
9964
  type: "boolean"
9962
9965
  },
9966
+ can_unlock_with_cloud_key: {
9967
+ description: "Indicates whether the ACS entrance can be remotely unlocked using a cloud_key credential.",
9968
+ type: "boolean"
9969
+ },
9963
9970
  can_unlock_with_code: {
9964
9971
  description: "Indicates whether the ACS entrance can be unlocked with pin codes.",
9965
9972
  type: "boolean"
@@ -28240,6 +28247,10 @@ var openapi_default = {
28240
28247
  description: "Indicates whether the ACS entrance can be unlocked with card credentials.",
28241
28248
  type: "boolean"
28242
28249
  },
28250
+ can_unlock_with_cloud_key: {
28251
+ description: "Indicates whether the ACS entrance can be remotely unlocked using a cloud_key credential.",
28252
+ type: "boolean"
28253
+ },
28243
28254
  can_unlock_with_code: {
28244
28255
  description: "Indicates whether the ACS entrance can be unlocked with pin codes.",
28245
28256
  type: "boolean"
@@ -46553,6 +46564,68 @@ var openapi_default = {
46553
46564
  "x-title": "List Credentials with Access to an Entrance"
46554
46565
  }
46555
46566
  },
46567
+ "/acs/entrances/unlock": {
46568
+ post: {
46569
+ description: "Remotely unlocks a specified [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) using a cloud_key credential. Returns an action attempt that tracks the progress of the unlock operation.",
46570
+ operationId: "acsEntrancesUnlockPost",
46571
+ requestBody: {
46572
+ content: {
46573
+ "application/json": {
46574
+ schema: {
46575
+ properties: {
46576
+ acs_credential_id: {
46577
+ description: "ID of the cloud_key credential to use for the unlock operation.",
46578
+ format: "uuid",
46579
+ type: "string"
46580
+ },
46581
+ acs_entrance_id: {
46582
+ description: "ID of the entrance to unlock.",
46583
+ format: "uuid",
46584
+ type: "string"
46585
+ }
46586
+ },
46587
+ required: ["acs_entrance_id", "acs_credential_id"],
46588
+ type: "object"
46589
+ }
46590
+ }
46591
+ }
46592
+ },
46593
+ responses: {
46594
+ 200: {
46595
+ content: {
46596
+ "application/json": {
46597
+ schema: {
46598
+ properties: {
46599
+ action_attempt: {
46600
+ $ref: "#/components/schemas/action_attempt"
46601
+ },
46602
+ ok: { type: "boolean" }
46603
+ },
46604
+ required: ["action_attempt", "ok"],
46605
+ type: "object"
46606
+ }
46607
+ }
46608
+ },
46609
+ description: "OK"
46610
+ },
46611
+ 400: { description: "Bad Request" },
46612
+ 401: { description: "Unauthorized" }
46613
+ },
46614
+ security: [
46615
+ { pat_with_workspace: [] },
46616
+ { console_session_with_workspace: [] },
46617
+ { api_key: [] }
46618
+ ],
46619
+ summary: "/acs/entrances/unlock",
46620
+ tags: ["/acs"],
46621
+ "x-action-attempt-type": "UNLOCK_DOOR",
46622
+ "x-fern-sdk-group-name": ["acs", "entrances"],
46623
+ "x-fern-sdk-method-name": "unlock",
46624
+ "x-fern-sdk-return-value": "action_attempt",
46625
+ "x-response-key": "action_attempt",
46626
+ "x-title": "Unlock an Entrance"
46627
+ }
46628
+ },
46556
46629
  "/acs/systems/get": {
46557
46630
  get: {
46558
46631
  description: "Returns a specified [access system](https://docs.seam.co/latest/capability-guides/access-systems).",
@@ -62672,8 +62745,18 @@ var openapi_default = {
62672
62745
  },
62673
62746
  "/seam/customer/v1/automations/get": {
62674
62747
  get: {
62675
- 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.",
62748
+ description: "Gets the current automation configuration for a customer portal workspace.\nWhen customer_key is provided, returns customer-specific config if available,\notherwise falls back to workspace-level config.",
62676
62749
  operationId: "seamCustomerV1AutomationsGetGet",
62750
+ parameters: [
62751
+ {
62752
+ in: "query",
62753
+ name: "customer_key",
62754
+ schema: {
62755
+ description: "Key of the customer to get automation config for.",
62756
+ type: "string"
62757
+ }
62758
+ }
62759
+ ],
62677
62760
  responses: {
62678
62761
  200: {
62679
62762
  content: {
@@ -62943,11 +63026,7 @@ var openapi_default = {
62943
63026
  400: { description: "Bad Request" },
62944
63027
  401: { description: "Unauthorized" }
62945
63028
  },
62946
- security: [
62947
- { console_session_with_workspace: [] },
62948
- { api_key: [] },
62949
- { client_session_with_customer: [] }
62950
- ],
63029
+ security: [{ console_session_with_workspace: [] }, { api_key: [] }],
62951
63030
  summary: "/seam/customer/v1/automations/get",
62952
63031
  tags: [],
62953
63032
  "x-fern-sdk-group-name": ["seam", "customer", "v1", "automations"],
@@ -62957,8 +63036,23 @@ var openapi_default = {
62957
63036
  "x-undocumented": "Internal endpoint for customer portals."
62958
63037
  },
62959
63038
  post: {
62960
- 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.",
63039
+ description: "Gets the current automation configuration for a customer portal workspace.\nWhen customer_key is provided, returns customer-specific config if available,\notherwise falls back to workspace-level config.",
62961
63040
  operationId: "seamCustomerV1AutomationsGetPost",
63041
+ requestBody: {
63042
+ content: {
63043
+ "application/json": {
63044
+ schema: {
63045
+ properties: {
63046
+ customer_key: {
63047
+ description: "Key of the customer to get automation config for.",
63048
+ type: "string"
63049
+ }
63050
+ },
63051
+ type: "object"
63052
+ }
63053
+ }
63054
+ }
63055
+ },
62962
63056
  responses: {
62963
63057
  200: {
62964
63058
  content: {
@@ -63228,11 +63322,7 @@ var openapi_default = {
63228
63322
  400: { description: "Bad Request" },
63229
63323
  401: { description: "Unauthorized" }
63230
63324
  },
63231
- security: [
63232
- { console_session_with_workspace: [] },
63233
- { api_key: [] },
63234
- { client_session_with_customer: [] }
63235
- ],
63325
+ security: [{ console_session_with_workspace: [] }, { api_key: [] }],
63236
63326
  summary: "/seam/customer/v1/automations/get",
63237
63327
  tags: [],
63238
63328
  "x-fern-sdk-group-name": ["seam", "customer", "v1", "automations"],
@@ -63490,6 +63580,10 @@ var openapi_default = {
63490
63580
  }
63491
63581
  },
63492
63582
  type: "object"
63583
+ },
63584
+ customer_key: {
63585
+ description: "Key of the customer to update automation config for.",
63586
+ type: "string"
63493
63587
  }
63494
63588
  },
63495
63589
  type: "object"
@@ -63769,6 +63863,10 @@ var openapi_default = {
63769
63863
  }
63770
63864
  },
63771
63865
  type: "object"
63866
+ },
63867
+ customer_key: {
63868
+ description: "Key of the customer to update automation config for.",
63869
+ type: "string"
63772
63870
  }
63773
63871
  },
63774
63872
  type: "object"
@@ -64759,16 +64857,8 @@ var openapi_default = {
64759
64857
  },
64760
64858
  "/seam/customer/v1/customers/automations/get": {
64761
64859
  get: {
64762
- description: "Gets the automation configuration for a specific customer.\nReturns the merged configuration (customer overrides on top of workspace defaults).",
64860
+ description: "Gets the automation configuration for the authenticated customer.\nReturns the merged configuration (customer overrides on top of workspace defaults).",
64763
64861
  operationId: "seamCustomerV1CustomersAutomationsGetGet",
64764
- parameters: [
64765
- {
64766
- in: "query",
64767
- name: "customer_key",
64768
- required: true,
64769
- schema: { description: "Key of the customer.", type: "string" }
64770
- }
64771
- ],
64772
64862
  responses: {
64773
64863
  200: {
64774
64864
  content: {
@@ -65047,11 +65137,7 @@ var openapi_default = {
65047
65137
  400: { description: "Bad Request" },
65048
65138
  401: { description: "Unauthorized" }
65049
65139
  },
65050
- security: [
65051
- { pat_with_workspace: [] },
65052
- { console_session_with_workspace: [] },
65053
- { api_key: [] }
65054
- ],
65140
+ security: [{ client_session_with_customer: [] }],
65055
65141
  summary: "/seam/customer/v1/customers/automations/get",
65056
65142
  tags: [],
65057
65143
  "x-fern-sdk-group-name": [
@@ -65067,24 +65153,8 @@ var openapi_default = {
65067
65153
  "x-title": "Get Customer Automation Configuration"
65068
65154
  },
65069
65155
  post: {
65070
- description: "Gets the automation configuration for a specific customer.\nReturns the merged configuration (customer overrides on top of workspace defaults).",
65156
+ description: "Gets the automation configuration for the authenticated customer.\nReturns the merged configuration (customer overrides on top of workspace defaults).",
65071
65157
  operationId: "seamCustomerV1CustomersAutomationsGetPost",
65072
- requestBody: {
65073
- content: {
65074
- "application/json": {
65075
- schema: {
65076
- properties: {
65077
- customer_key: {
65078
- description: "Key of the customer.",
65079
- type: "string"
65080
- }
65081
- },
65082
- required: ["customer_key"],
65083
- type: "object"
65084
- }
65085
- }
65086
- }
65087
- },
65088
65158
  responses: {
65089
65159
  200: {
65090
65160
  content: {
@@ -65363,11 +65433,7 @@ var openapi_default = {
65363
65433
  400: { description: "Bad Request" },
65364
65434
  401: { description: "Unauthorized" }
65365
65435
  },
65366
- security: [
65367
- { pat_with_workspace: [] },
65368
- { console_session_with_workspace: [] },
65369
- { api_key: [] }
65370
- ],
65436
+ security: [{ client_session_with_customer: [] }],
65371
65437
  summary: "/seam/customer/v1/customers/automations/get",
65372
65438
  tags: [],
65373
65439
  "x-fern-sdk-group-name": [