@seamapi/types 1.748.0 → 1.750.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
@@ -3159,6 +3159,7 @@ var acs_credential_visionline_metadata = zod.z.object({
3159
3159
  var acs_credential_external_type = zod.z.enum([
3160
3160
  "pti_card",
3161
3161
  "brivo_credential",
3162
+ "brivo_digital_credential",
3162
3163
  "hid_credential",
3163
3164
  "visionline_card",
3164
3165
  "salto_ks_credential",
@@ -3171,7 +3172,8 @@ var acs_credential_external_type = zod.z.enum([
3171
3172
  var acs_credential_access_method_type = zod.z.enum([
3172
3173
  "code",
3173
3174
  "card",
3174
- "mobile_key"
3175
+ "mobile_key",
3176
+ "cloud_key"
3175
3177
  ]);
3176
3178
  var common_acs_credential_warning = zod.z.object({
3177
3179
  created_at: zod.z.string().datetime().describe("Date and time at which Seam created the warning."),
@@ -3267,7 +3269,7 @@ var common_acs_credential = zod.z.object({
3267
3269
  "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card."
3268
3270
  ),
3269
3271
  access_method: acs_credential_access_method_type.describe(
3270
- "Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`."
3272
+ "Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`."
3271
3273
  ),
3272
3274
  external_type: acs_credential_external_type.optional().describe(
3273
3275
  "Brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`."
@@ -9411,8 +9413,8 @@ var openapi_default = {
9411
9413
  description: "Means by which an [access control system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).\n\nAn access control system generally uses digital means of access to authorize a user trying to get through a specific entrance. Examples of credentials include plastic key cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs.\n\nFor each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type.",
9412
9414
  properties: {
9413
9415
  access_method: {
9414
- description: "Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`.",
9415
- enum: ["code", "card", "mobile_key"],
9416
+ description: "Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`.",
9417
+ enum: ["code", "card", "mobile_key", "cloud_key"],
9416
9418
  type: "string"
9417
9419
  },
9418
9420
  acs_credential_id: {
@@ -9509,6 +9511,7 @@ var openapi_default = {
9509
9511
  enum: [
9510
9512
  "pti_card",
9511
9513
  "brivo_credential",
9514
+ "brivo_digital_credential",
9512
9515
  "hid_credential",
9513
9516
  "visionline_card",
9514
9517
  "salto_ks_credential",
@@ -11667,8 +11670,8 @@ var openapi_default = {
11667
11670
  description: "Means by which an [access control system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).\n\nAn access control system generally uses digital means of access to authorize a user trying to get through a specific entrance. Examples of credentials include plastic key cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs.\n\nFor each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type.",
11668
11671
  properties: {
11669
11672
  access_method: {
11670
- description: "Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`.",
11671
- enum: ["code", "card", "mobile_key"],
11673
+ description: "Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`.",
11674
+ enum: ["code", "card", "mobile_key", "cloud_key"],
11672
11675
  type: "string"
11673
11676
  },
11674
11677
  acs_credential_id: {
@@ -11768,6 +11771,7 @@ var openapi_default = {
11768
11771
  enum: [
11769
11772
  "pti_card",
11770
11773
  "brivo_credential",
11774
+ "brivo_digital_credential",
11771
11775
  "hid_credential",
11772
11776
  "visionline_card",
11773
11777
  "salto_ks_credential",
@@ -12057,8 +12061,8 @@ var openapi_default = {
12057
12061
  description: "Means by which an [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `unmanaged_acs_credential` object, which is not managed by Seam, represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). For each `acs_credential` object, you define the access method. You can also specify additional properties, such as a PIN code.",
12058
12062
  properties: {
12059
12063
  access_method: {
12060
- description: "Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`.",
12061
- enum: ["code", "card", "mobile_key"],
12064
+ description: "Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`.",
12065
+ enum: ["code", "card", "mobile_key", "cloud_key"],
12062
12066
  type: "string"
12063
12067
  },
12064
12068
  acs_credential_id: {
@@ -12158,6 +12162,7 @@ var openapi_default = {
12158
12162
  enum: [
12159
12163
  "pti_card",
12160
12164
  "brivo_credential",
12165
+ "brivo_digital_credential",
12161
12166
  "hid_credential",
12162
12167
  "visionline_card",
12163
12168
  "salto_ks_credential",
@@ -12641,8 +12646,8 @@ var openapi_default = {
12641
12646
  description: "Means by which an [access control system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).\n\nAn access control system generally uses digital means of access to authorize a user trying to get through a specific entrance. Examples of credentials include plastic key cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs.\n\nFor each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type.",
12642
12647
  properties: {
12643
12648
  access_method: {
12644
- description: "Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`.",
12645
- enum: ["code", "card", "mobile_key"],
12649
+ description: "Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`.",
12650
+ enum: ["code", "card", "mobile_key", "cloud_key"],
12646
12651
  type: "string"
12647
12652
  },
12648
12653
  acs_credential_id: {
@@ -12742,6 +12747,7 @@ var openapi_default = {
12742
12747
  enum: [
12743
12748
  "pti_card",
12744
12749
  "brivo_credential",
12750
+ "brivo_digital_credential",
12745
12751
  "hid_credential",
12746
12752
  "visionline_card",
12747
12753
  "salto_ks_credential",
@@ -13029,8 +13035,8 @@ var openapi_default = {
13029
13035
  description: "Means by which an [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `unmanaged_acs_credential` object, which is not managed by Seam, represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). For each `acs_credential` object, you define the access method. You can also specify additional properties, such as a PIN code.",
13030
13036
  properties: {
13031
13037
  access_method: {
13032
- description: "Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`.",
13033
- enum: ["code", "card", "mobile_key"],
13038
+ description: "Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`.",
13039
+ enum: ["code", "card", "mobile_key", "cloud_key"],
13034
13040
  type: "string"
13035
13041
  },
13036
13042
  acs_credential_id: {
@@ -13130,6 +13136,7 @@ var openapi_default = {
13130
13136
  enum: [
13131
13137
  "pti_card",
13132
13138
  "brivo_credential",
13139
+ "brivo_digital_credential",
13133
13140
  "hid_credential",
13134
13141
  "visionline_card",
13135
13142
  "salto_ks_credential",
@@ -28144,8 +28151,8 @@ var openapi_default = {
28144
28151
  description: "Means by which an [access control system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).\n\nAn access control system generally uses digital means of access to authorize a user trying to get through a specific entrance. Examples of credentials include plastic key cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs.\n\nFor each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type.",
28145
28152
  properties: {
28146
28153
  access_method: {
28147
- description: "Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`.",
28148
- enum: ["code", "card", "mobile_key"],
28154
+ description: "Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`.",
28155
+ enum: ["code", "card", "mobile_key", "cloud_key"],
28149
28156
  type: "string"
28150
28157
  },
28151
28158
  acs_credential_id: { nullable: true, type: "string" },
@@ -28567,6 +28574,7 @@ var openapi_default = {
28567
28574
  enum: [
28568
28575
  "pti_card",
28569
28576
  "brivo_credential",
28577
+ "brivo_digital_credential",
28570
28578
  "hid_credential",
28571
28579
  "visionline_card",
28572
28580
  "salto_ks_credential",
@@ -31333,8 +31341,8 @@ var openapi_default = {
31333
31341
  description: "Means by which an [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `unmanaged_acs_credential` object, which is not managed by Seam, represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). For each `acs_credential` object, you define the access method. You can also specify additional properties, such as a PIN code.",
31334
31342
  properties: {
31335
31343
  access_method: {
31336
- description: "Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`.",
31337
- enum: ["code", "card", "mobile_key"],
31344
+ description: "Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`.",
31345
+ enum: ["code", "card", "mobile_key", "cloud_key"],
31338
31346
  type: "string"
31339
31347
  },
31340
31348
  acs_credential_id: {
@@ -31431,6 +31439,7 @@ var openapi_default = {
31431
31439
  enum: [
31432
31440
  "pti_card",
31433
31441
  "brivo_credential",
31442
+ "brivo_digital_credential",
31434
31443
  "hid_credential",
31435
31444
  "visionline_card",
31436
31445
  "salto_ks_credential",
@@ -44072,8 +44081,8 @@ var openapi_default = {
44072
44081
  schema: {
44073
44082
  properties: {
44074
44083
  access_method: {
44075
- description: "Access method for the new credential. Supported values: `code`, `card`, `mobile_key`.",
44076
- enum: ["code", "card", "mobile_key"],
44084
+ description: "Access method for the new credential. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.",
44085
+ enum: ["code", "card", "mobile_key", "cloud_key"],
44077
44086
  type: "string"
44078
44087
  },
44079
44088
  acs_system_id: {
@@ -62663,8 +62672,18 @@ var openapi_default = {
62663
62672
  },
62664
62673
  "/seam/customer/v1/automations/get": {
62665
62674
  get: {
62666
- 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.",
62675
+ 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.",
62667
62676
  operationId: "seamCustomerV1AutomationsGetGet",
62677
+ parameters: [
62678
+ {
62679
+ in: "query",
62680
+ name: "customer_key",
62681
+ schema: {
62682
+ description: "Key of the customer to get automation config for.",
62683
+ type: "string"
62684
+ }
62685
+ }
62686
+ ],
62668
62687
  responses: {
62669
62688
  200: {
62670
62689
  content: {
@@ -62934,11 +62953,7 @@ var openapi_default = {
62934
62953
  400: { description: "Bad Request" },
62935
62954
  401: { description: "Unauthorized" }
62936
62955
  },
62937
- security: [
62938
- { console_session_with_workspace: [] },
62939
- { api_key: [] },
62940
- { client_session_with_customer: [] }
62941
- ],
62956
+ security: [{ console_session_with_workspace: [] }, { api_key: [] }],
62942
62957
  summary: "/seam/customer/v1/automations/get",
62943
62958
  tags: [],
62944
62959
  "x-fern-sdk-group-name": ["seam", "customer", "v1", "automations"],
@@ -62948,8 +62963,23 @@ var openapi_default = {
62948
62963
  "x-undocumented": "Internal endpoint for customer portals."
62949
62964
  },
62950
62965
  post: {
62951
- 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.",
62966
+ 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.",
62952
62967
  operationId: "seamCustomerV1AutomationsGetPost",
62968
+ requestBody: {
62969
+ content: {
62970
+ "application/json": {
62971
+ schema: {
62972
+ properties: {
62973
+ customer_key: {
62974
+ description: "Key of the customer to get automation config for.",
62975
+ type: "string"
62976
+ }
62977
+ },
62978
+ type: "object"
62979
+ }
62980
+ }
62981
+ }
62982
+ },
62953
62983
  responses: {
62954
62984
  200: {
62955
62985
  content: {
@@ -63219,11 +63249,7 @@ var openapi_default = {
63219
63249
  400: { description: "Bad Request" },
63220
63250
  401: { description: "Unauthorized" }
63221
63251
  },
63222
- security: [
63223
- { console_session_with_workspace: [] },
63224
- { api_key: [] },
63225
- { client_session_with_customer: [] }
63226
- ],
63252
+ security: [{ console_session_with_workspace: [] }, { api_key: [] }],
63227
63253
  summary: "/seam/customer/v1/automations/get",
63228
63254
  tags: [],
63229
63255
  "x-fern-sdk-group-name": ["seam", "customer", "v1", "automations"],
@@ -63481,6 +63507,10 @@ var openapi_default = {
63481
63507
  }
63482
63508
  },
63483
63509
  type: "object"
63510
+ },
63511
+ customer_key: {
63512
+ description: "Key of the customer to update automation config for.",
63513
+ type: "string"
63484
63514
  }
63485
63515
  },
63486
63516
  type: "object"
@@ -63760,6 +63790,10 @@ var openapi_default = {
63760
63790
  }
63761
63791
  },
63762
63792
  type: "object"
63793
+ },
63794
+ customer_key: {
63795
+ description: "Key of the customer to update automation config for.",
63796
+ type: "string"
63763
63797
  }
63764
63798
  },
63765
63799
  type: "object"
@@ -64750,16 +64784,8 @@ var openapi_default = {
64750
64784
  },
64751
64785
  "/seam/customer/v1/customers/automations/get": {
64752
64786
  get: {
64753
- description: "Gets the automation configuration for a specific customer.\nReturns the merged configuration (customer overrides on top of workspace defaults).",
64787
+ description: "Gets the automation configuration for the authenticated customer.\nReturns the merged configuration (customer overrides on top of workspace defaults).",
64754
64788
  operationId: "seamCustomerV1CustomersAutomationsGetGet",
64755
- parameters: [
64756
- {
64757
- in: "query",
64758
- name: "customer_key",
64759
- required: true,
64760
- schema: { description: "Key of the customer.", type: "string" }
64761
- }
64762
- ],
64763
64789
  responses: {
64764
64790
  200: {
64765
64791
  content: {
@@ -65038,11 +65064,7 @@ var openapi_default = {
65038
65064
  400: { description: "Bad Request" },
65039
65065
  401: { description: "Unauthorized" }
65040
65066
  },
65041
- security: [
65042
- { pat_with_workspace: [] },
65043
- { console_session_with_workspace: [] },
65044
- { api_key: [] }
65045
- ],
65067
+ security: [{ client_session_with_customer: [] }],
65046
65068
  summary: "/seam/customer/v1/customers/automations/get",
65047
65069
  tags: [],
65048
65070
  "x-fern-sdk-group-name": [
@@ -65058,24 +65080,8 @@ var openapi_default = {
65058
65080
  "x-title": "Get Customer Automation Configuration"
65059
65081
  },
65060
65082
  post: {
65061
- description: "Gets the automation configuration for a specific customer.\nReturns the merged configuration (customer overrides on top of workspace defaults).",
65083
+ description: "Gets the automation configuration for the authenticated customer.\nReturns the merged configuration (customer overrides on top of workspace defaults).",
65062
65084
  operationId: "seamCustomerV1CustomersAutomationsGetPost",
65063
- requestBody: {
65064
- content: {
65065
- "application/json": {
65066
- schema: {
65067
- properties: {
65068
- customer_key: {
65069
- description: "Key of the customer.",
65070
- type: "string"
65071
- }
65072
- },
65073
- required: ["customer_key"],
65074
- type: "object"
65075
- }
65076
- }
65077
- }
65078
- },
65079
65085
  responses: {
65080
65086
  200: {
65081
65087
  content: {
@@ -65354,11 +65360,7 @@ var openapi_default = {
65354
65360
  400: { description: "Bad Request" },
65355
65361
  401: { description: "Unauthorized" }
65356
65362
  },
65357
- security: [
65358
- { pat_with_workspace: [] },
65359
- { console_session_with_workspace: [] },
65360
- { api_key: [] }
65361
- ],
65363
+ security: [{ client_session_with_customer: [] }],
65362
65364
  summary: "/seam/customer/v1/customers/automations/get",
65363
65365
  tags: [],
65364
65366
  "x-fern-sdk-group-name": [