@seamapi/types 1.400.0 → 1.402.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 +652 -8
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +848 -73
- package/lib/seam/connect/internal/schemas.d.ts +1 -1
- package/lib/seam/connect/internal/schemas.js +1 -1
- package/lib/seam/connect/internal/schemas.js.map +1 -1
- package/lib/seam/connect/models/index.d.ts +1 -0
- package/lib/seam/connect/models/index.js +1 -0
- package/lib/seam/connect/models/index.js.map +1 -1
- package/lib/seam/connect/models/phones/index.d.ts +2 -0
- package/lib/seam/connect/models/phones/index.js +3 -0
- package/lib/seam/connect/models/phones/index.js.map +1 -0
- package/lib/seam/connect/models/phones/phone-registration.d.ts +18 -0
- package/lib/seam/connect/models/phones/phone-registration.js +13 -0
- package/lib/seam/connect/models/phones/phone-registration.js.map +1 -0
- package/lib/seam/connect/models/phones/phone-session.d.ts +2060 -0
- package/lib/seam/connect/models/phones/phone-session.js +21 -0
- package/lib/seam/connect/models/phones/phone-session.js.map +1 -0
- package/lib/seam/connect/openapi.d.ts +566 -0
- package/lib/seam/connect/openapi.js +652 -8
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +213 -4
- package/package.json +1 -1
- package/src/lib/seam/connect/internal/schemas.ts +2 -0
- package/src/lib/seam/connect/models/index.ts +1 -0
- package/src/lib/seam/connect/models/phones/index.ts +2 -0
- package/src/lib/seam/connect/models/phones/phone-registration.ts +15 -0
- package/src/lib/seam/connect/models/phones/phone-session.ts +27 -0
- package/src/lib/seam/connect/openapi.ts +720 -8
- package/src/lib/seam/connect/route-types.ts +267 -4
package/dist/connect.cjs
CHANGED
|
@@ -18452,6 +18452,572 @@ var openapi_default = {
|
|
|
18452
18452
|
type: "object",
|
|
18453
18453
|
"x-route-path": "/phones"
|
|
18454
18454
|
},
|
|
18455
|
+
phone_registration: {
|
|
18456
|
+
properties: {
|
|
18457
|
+
is_being_activated: { type: "boolean" },
|
|
18458
|
+
phone_registration_id: { type: "string" },
|
|
18459
|
+
provider_name: { nullable: true, type: "string" },
|
|
18460
|
+
provider_state: {}
|
|
18461
|
+
},
|
|
18462
|
+
required: [
|
|
18463
|
+
"phone_registration_id",
|
|
18464
|
+
"provider_name",
|
|
18465
|
+
"is_being_activated"
|
|
18466
|
+
],
|
|
18467
|
+
type: "object",
|
|
18468
|
+
"x-route-path": "/seam/mobile_sdk/v1/phone_sessions",
|
|
18469
|
+
"x-undocumented": "Seam Mobile SDK only."
|
|
18470
|
+
},
|
|
18471
|
+
phone_session: {
|
|
18472
|
+
properties: {
|
|
18473
|
+
provider_sessions: {
|
|
18474
|
+
items: {
|
|
18475
|
+
properties: {
|
|
18476
|
+
acs_credentials: {
|
|
18477
|
+
items: {
|
|
18478
|
+
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.",
|
|
18479
|
+
properties: {
|
|
18480
|
+
access_method: {
|
|
18481
|
+
description: "Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`.",
|
|
18482
|
+
enum: ["code", "card", "mobile_key"],
|
|
18483
|
+
type: "string"
|
|
18484
|
+
},
|
|
18485
|
+
acs_credential_id: {
|
|
18486
|
+
description: "ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
|
|
18487
|
+
format: "uuid",
|
|
18488
|
+
type: "string"
|
|
18489
|
+
},
|
|
18490
|
+
acs_credential_pool_id: {
|
|
18491
|
+
format: "uuid",
|
|
18492
|
+
type: "string"
|
|
18493
|
+
},
|
|
18494
|
+
acs_entrances: {
|
|
18495
|
+
items: {
|
|
18496
|
+
description: "Represents an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).\n\nIn an access control system, an entrance is a secured door, gate, zone, or other method of entry. You can list details for all the `acs_entrance` resources in your workspace or get these details for a specific `acs_entrance`. You can also list all entrances associated with a specific credential, and you can list all credentials associated with a specific entrance.",
|
|
18497
|
+
properties: {
|
|
18498
|
+
acs_entrance_id: {
|
|
18499
|
+
description: "ID of the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).",
|
|
18500
|
+
format: "uuid",
|
|
18501
|
+
type: "string"
|
|
18502
|
+
},
|
|
18503
|
+
acs_system_id: {
|
|
18504
|
+
description: "ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).",
|
|
18505
|
+
format: "uuid",
|
|
18506
|
+
type: "string"
|
|
18507
|
+
},
|
|
18508
|
+
assa_abloy_vostio_metadata: {
|
|
18509
|
+
description: "ASSA ABLOY Vostio-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).",
|
|
18510
|
+
properties: {
|
|
18511
|
+
door_name: { type: "string" },
|
|
18512
|
+
door_number: {
|
|
18513
|
+
format: "float",
|
|
18514
|
+
type: "number"
|
|
18515
|
+
},
|
|
18516
|
+
door_type: {
|
|
18517
|
+
enum: [
|
|
18518
|
+
"CommonDoor",
|
|
18519
|
+
"EntranceDoor",
|
|
18520
|
+
"GuestDoor",
|
|
18521
|
+
"Elevator"
|
|
18522
|
+
],
|
|
18523
|
+
type: "string"
|
|
18524
|
+
},
|
|
18525
|
+
pms_id: { type: "string" },
|
|
18526
|
+
stand_open: { type: "boolean" }
|
|
18527
|
+
},
|
|
18528
|
+
required: ["door_type", "door_name"],
|
|
18529
|
+
type: "object"
|
|
18530
|
+
},
|
|
18531
|
+
created_at: {
|
|
18532
|
+
description: "Date and time at which the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) was created.",
|
|
18533
|
+
format: "date-time",
|
|
18534
|
+
type: "string"
|
|
18535
|
+
},
|
|
18536
|
+
display_name: {
|
|
18537
|
+
description: "Display name for the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).",
|
|
18538
|
+
type: "string"
|
|
18539
|
+
},
|
|
18540
|
+
dormakaba_community_metadata: {
|
|
18541
|
+
description: "dormakaba Community-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).",
|
|
18542
|
+
properties: {
|
|
18543
|
+
access_point_name: { type: "string" }
|
|
18544
|
+
},
|
|
18545
|
+
required: ["access_point_name"],
|
|
18546
|
+
type: "object"
|
|
18547
|
+
},
|
|
18548
|
+
errors: {
|
|
18549
|
+
description: "Errors associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).",
|
|
18550
|
+
items: {
|
|
18551
|
+
properties: {
|
|
18552
|
+
error_code: {
|
|
18553
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
18554
|
+
type: "string"
|
|
18555
|
+
},
|
|
18556
|
+
message: {
|
|
18557
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
18558
|
+
type: "string"
|
|
18559
|
+
}
|
|
18560
|
+
},
|
|
18561
|
+
required: ["error_code", "message"],
|
|
18562
|
+
type: "object"
|
|
18563
|
+
},
|
|
18564
|
+
type: "array"
|
|
18565
|
+
},
|
|
18566
|
+
latch_metadata: {
|
|
18567
|
+
description: "Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).",
|
|
18568
|
+
properties: {
|
|
18569
|
+
accessibility_type: { type: "string" },
|
|
18570
|
+
door_name: { type: "string" },
|
|
18571
|
+
door_type: { type: "string" },
|
|
18572
|
+
is_connected: { type: "boolean" }
|
|
18573
|
+
},
|
|
18574
|
+
required: [
|
|
18575
|
+
"accessibility_type",
|
|
18576
|
+
"door_name",
|
|
18577
|
+
"door_type",
|
|
18578
|
+
"is_connected"
|
|
18579
|
+
],
|
|
18580
|
+
type: "object"
|
|
18581
|
+
},
|
|
18582
|
+
salto_ks_metadata: {
|
|
18583
|
+
description: "Salto KS-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).",
|
|
18584
|
+
properties: {
|
|
18585
|
+
battery_level: { type: "string" },
|
|
18586
|
+
door_name: { type: "string" },
|
|
18587
|
+
intrusion_alarm: { type: "boolean" },
|
|
18588
|
+
left_open_alarm: { type: "boolean" },
|
|
18589
|
+
lock_type: { type: "string" },
|
|
18590
|
+
locked_state: { type: "string" },
|
|
18591
|
+
online: { type: "boolean" },
|
|
18592
|
+
privacy_mode: { type: "boolean" }
|
|
18593
|
+
},
|
|
18594
|
+
required: [
|
|
18595
|
+
"door_name",
|
|
18596
|
+
"locked_state",
|
|
18597
|
+
"lock_type",
|
|
18598
|
+
"battery_level"
|
|
18599
|
+
],
|
|
18600
|
+
type: "object"
|
|
18601
|
+
},
|
|
18602
|
+
salto_space_metadata: {
|
|
18603
|
+
description: "Salto Space-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).",
|
|
18604
|
+
properties: {
|
|
18605
|
+
door_description: { type: "string" },
|
|
18606
|
+
door_name: { type: "string" },
|
|
18607
|
+
ext_door_id: { type: "string" }
|
|
18608
|
+
},
|
|
18609
|
+
required: ["door_name", "ext_door_id"],
|
|
18610
|
+
type: "object"
|
|
18611
|
+
},
|
|
18612
|
+
visionline_metadata: {
|
|
18613
|
+
description: "Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).",
|
|
18614
|
+
properties: {
|
|
18615
|
+
door_category: {
|
|
18616
|
+
enum: [
|
|
18617
|
+
"entrance",
|
|
18618
|
+
"guest",
|
|
18619
|
+
"elevator reader",
|
|
18620
|
+
"common",
|
|
18621
|
+
"common (PMS)"
|
|
18622
|
+
],
|
|
18623
|
+
type: "string"
|
|
18624
|
+
},
|
|
18625
|
+
door_name: { type: "string" },
|
|
18626
|
+
profiles: {
|
|
18627
|
+
items: {
|
|
18628
|
+
properties: {
|
|
18629
|
+
visionline_door_profile_id: {
|
|
18630
|
+
type: "string"
|
|
18631
|
+
},
|
|
18632
|
+
visionline_door_profile_type: {
|
|
18633
|
+
enum: ["BLE", "commonDoor", "touch"],
|
|
18634
|
+
type: "string"
|
|
18635
|
+
}
|
|
18636
|
+
},
|
|
18637
|
+
required: [
|
|
18638
|
+
"visionline_door_profile_id",
|
|
18639
|
+
"visionline_door_profile_type"
|
|
18640
|
+
],
|
|
18641
|
+
type: "object"
|
|
18642
|
+
},
|
|
18643
|
+
type: "array"
|
|
18644
|
+
}
|
|
18645
|
+
},
|
|
18646
|
+
required: ["door_name", "door_category"],
|
|
18647
|
+
type: "object"
|
|
18648
|
+
}
|
|
18649
|
+
},
|
|
18650
|
+
required: [
|
|
18651
|
+
"acs_system_id",
|
|
18652
|
+
"acs_entrance_id",
|
|
18653
|
+
"created_at",
|
|
18654
|
+
"display_name",
|
|
18655
|
+
"errors"
|
|
18656
|
+
],
|
|
18657
|
+
type: "object",
|
|
18658
|
+
"x-route-path": "/acs/entrances"
|
|
18659
|
+
},
|
|
18660
|
+
type: "array"
|
|
18661
|
+
},
|
|
18662
|
+
acs_system_id: {
|
|
18663
|
+
description: "ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
|
|
18664
|
+
format: "uuid",
|
|
18665
|
+
type: "string"
|
|
18666
|
+
},
|
|
18667
|
+
acs_user_id: {
|
|
18668
|
+
description: "ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs.",
|
|
18669
|
+
format: "uuid",
|
|
18670
|
+
type: "string"
|
|
18671
|
+
},
|
|
18672
|
+
assa_abloy_vostio_metadata: {
|
|
18673
|
+
description: "Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
|
|
18674
|
+
properties: {
|
|
18675
|
+
auto_join: { type: "boolean" },
|
|
18676
|
+
door_names: {
|
|
18677
|
+
items: { type: "string" },
|
|
18678
|
+
type: "array"
|
|
18679
|
+
},
|
|
18680
|
+
endpoint_id: { type: "string" },
|
|
18681
|
+
key_id: { type: "string" },
|
|
18682
|
+
key_issuing_request_id: { type: "string" },
|
|
18683
|
+
override_guest_acs_entrance_ids: {
|
|
18684
|
+
items: { type: "string" },
|
|
18685
|
+
type: "array"
|
|
18686
|
+
}
|
|
18687
|
+
},
|
|
18688
|
+
type: "object"
|
|
18689
|
+
},
|
|
18690
|
+
card_number: {
|
|
18691
|
+
description: "Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
|
|
18692
|
+
nullable: true,
|
|
18693
|
+
type: "string"
|
|
18694
|
+
},
|
|
18695
|
+
code: {
|
|
18696
|
+
description: "Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
|
|
18697
|
+
nullable: true,
|
|
18698
|
+
type: "string"
|
|
18699
|
+
},
|
|
18700
|
+
created_at: {
|
|
18701
|
+
description: "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created.",
|
|
18702
|
+
format: "date-time",
|
|
18703
|
+
type: "string"
|
|
18704
|
+
},
|
|
18705
|
+
display_name: {
|
|
18706
|
+
description: "Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type.",
|
|
18707
|
+
minLength: 1,
|
|
18708
|
+
type: "string"
|
|
18709
|
+
},
|
|
18710
|
+
ends_at: {
|
|
18711
|
+
description: "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.",
|
|
18712
|
+
type: "string"
|
|
18713
|
+
},
|
|
18714
|
+
errors: {
|
|
18715
|
+
description: "Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
|
|
18716
|
+
items: {
|
|
18717
|
+
properties: {
|
|
18718
|
+
error_code: { type: "string" },
|
|
18719
|
+
message: { type: "string" }
|
|
18720
|
+
},
|
|
18721
|
+
required: ["error_code", "message"],
|
|
18722
|
+
type: "object"
|
|
18723
|
+
},
|
|
18724
|
+
type: "array"
|
|
18725
|
+
},
|
|
18726
|
+
external_type: {
|
|
18727
|
+
description: "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`.",
|
|
18728
|
+
enum: [
|
|
18729
|
+
"pti_card",
|
|
18730
|
+
"brivo_credential",
|
|
18731
|
+
"hid_credential",
|
|
18732
|
+
"visionline_card",
|
|
18733
|
+
"salto_ks_credential",
|
|
18734
|
+
"assa_abloy_vostio_key",
|
|
18735
|
+
"salto_space_key",
|
|
18736
|
+
"latch_access"
|
|
18737
|
+
],
|
|
18738
|
+
type: "string"
|
|
18739
|
+
},
|
|
18740
|
+
external_type_display_name: {
|
|
18741
|
+
description: "Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type.",
|
|
18742
|
+
type: "string"
|
|
18743
|
+
},
|
|
18744
|
+
is_issued: {
|
|
18745
|
+
description: "Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card.",
|
|
18746
|
+
type: "boolean"
|
|
18747
|
+
},
|
|
18748
|
+
is_latest_desired_state_synced_with_provider: {
|
|
18749
|
+
description: "Indicates whether the latest state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been synced from Seam to the provider.",
|
|
18750
|
+
nullable: true,
|
|
18751
|
+
type: "boolean"
|
|
18752
|
+
},
|
|
18753
|
+
is_managed: { enum: [true], type: "boolean" },
|
|
18754
|
+
is_multi_phone_sync_credential: {
|
|
18755
|
+
description: "Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).",
|
|
18756
|
+
type: "boolean"
|
|
18757
|
+
},
|
|
18758
|
+
is_one_time_use: {
|
|
18759
|
+
description: "Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use.",
|
|
18760
|
+
type: "boolean"
|
|
18761
|
+
},
|
|
18762
|
+
issued_at: {
|
|
18763
|
+
description: "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card.",
|
|
18764
|
+
format: "date-time",
|
|
18765
|
+
nullable: true,
|
|
18766
|
+
type: "string"
|
|
18767
|
+
},
|
|
18768
|
+
latest_desired_state_synced_with_provider_at: {
|
|
18769
|
+
description: "Date and time at which the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was most recently synced from Seam to the provider.",
|
|
18770
|
+
format: "date-time",
|
|
18771
|
+
nullable: true,
|
|
18772
|
+
type: "string"
|
|
18773
|
+
},
|
|
18774
|
+
parent_acs_credential_id: {
|
|
18775
|
+
description: "ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
|
|
18776
|
+
format: "uuid",
|
|
18777
|
+
type: "string"
|
|
18778
|
+
},
|
|
18779
|
+
starts_at: {
|
|
18780
|
+
description: "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
|
|
18781
|
+
type: "string"
|
|
18782
|
+
},
|
|
18783
|
+
visionline_metadata: {
|
|
18784
|
+
description: "Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
|
|
18785
|
+
properties: {
|
|
18786
|
+
auto_join: { type: "boolean" },
|
|
18787
|
+
card_function_type: {
|
|
18788
|
+
enum: ["guest", "staff"],
|
|
18789
|
+
type: "string"
|
|
18790
|
+
},
|
|
18791
|
+
card_id: { type: "string" },
|
|
18792
|
+
common_acs_entrance_ids: {
|
|
18793
|
+
items: { format: "uuid", type: "string" },
|
|
18794
|
+
type: "array"
|
|
18795
|
+
},
|
|
18796
|
+
credential_id: { type: "string" },
|
|
18797
|
+
guest_acs_entrance_ids: {
|
|
18798
|
+
items: { format: "uuid", type: "string" },
|
|
18799
|
+
type: "array"
|
|
18800
|
+
},
|
|
18801
|
+
is_valid: { type: "boolean" },
|
|
18802
|
+
joiner_acs_credential_ids: {
|
|
18803
|
+
items: { format: "uuid", type: "string" },
|
|
18804
|
+
type: "array"
|
|
18805
|
+
}
|
|
18806
|
+
},
|
|
18807
|
+
required: ["card_function_type"],
|
|
18808
|
+
type: "object"
|
|
18809
|
+
},
|
|
18810
|
+
warnings: {
|
|
18811
|
+
description: "Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
|
|
18812
|
+
items: {
|
|
18813
|
+
description: "Warning associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
|
|
18814
|
+
discriminator: { propertyName: "warning_code" },
|
|
18815
|
+
oneOf: [
|
|
18816
|
+
{
|
|
18817
|
+
description: "Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is waiting to be issued.",
|
|
18818
|
+
properties: {
|
|
18819
|
+
created_at: {
|
|
18820
|
+
description: "Date and time at which Seam created the warning.",
|
|
18821
|
+
format: "date-time",
|
|
18822
|
+
type: "string"
|
|
18823
|
+
},
|
|
18824
|
+
message: {
|
|
18825
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
18826
|
+
type: "string"
|
|
18827
|
+
},
|
|
18828
|
+
warning_code: {
|
|
18829
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
18830
|
+
enum: ["waiting_to_be_issued"],
|
|
18831
|
+
type: "string"
|
|
18832
|
+
}
|
|
18833
|
+
},
|
|
18834
|
+
required: [
|
|
18835
|
+
"created_at",
|
|
18836
|
+
"message",
|
|
18837
|
+
"warning_code"
|
|
18838
|
+
],
|
|
18839
|
+
type: "object"
|
|
18840
|
+
},
|
|
18841
|
+
{
|
|
18842
|
+
description: "Indicates that the schedule of one of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)'s children was modified externally.",
|
|
18843
|
+
properties: {
|
|
18844
|
+
created_at: {
|
|
18845
|
+
description: "Date and time at which Seam created the warning.",
|
|
18846
|
+
format: "date-time",
|
|
18847
|
+
type: "string"
|
|
18848
|
+
},
|
|
18849
|
+
message: {
|
|
18850
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
18851
|
+
type: "string"
|
|
18852
|
+
},
|
|
18853
|
+
warning_code: {
|
|
18854
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
18855
|
+
enum: ["schedule_externally_modified"],
|
|
18856
|
+
type: "string"
|
|
18857
|
+
}
|
|
18858
|
+
},
|
|
18859
|
+
required: [
|
|
18860
|
+
"created_at",
|
|
18861
|
+
"message",
|
|
18862
|
+
"warning_code"
|
|
18863
|
+
],
|
|
18864
|
+
type: "object"
|
|
18865
|
+
},
|
|
18866
|
+
{
|
|
18867
|
+
description: "Indicates that the schedule of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was modified to avoid creating a credential with a start date in the past.",
|
|
18868
|
+
properties: {
|
|
18869
|
+
created_at: {
|
|
18870
|
+
description: "Date and time at which Seam created the warning.",
|
|
18871
|
+
format: "date-time",
|
|
18872
|
+
type: "string"
|
|
18873
|
+
},
|
|
18874
|
+
message: {
|
|
18875
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
18876
|
+
type: "string"
|
|
18877
|
+
},
|
|
18878
|
+
warning_code: {
|
|
18879
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
18880
|
+
enum: ["schedule_modified"],
|
|
18881
|
+
type: "string"
|
|
18882
|
+
}
|
|
18883
|
+
},
|
|
18884
|
+
required: [
|
|
18885
|
+
"created_at",
|
|
18886
|
+
"message",
|
|
18887
|
+
"warning_code"
|
|
18888
|
+
],
|
|
18889
|
+
type: "object"
|
|
18890
|
+
},
|
|
18891
|
+
{
|
|
18892
|
+
description: "Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is being deleted.",
|
|
18893
|
+
properties: {
|
|
18894
|
+
created_at: {
|
|
18895
|
+
description: "Date and time at which Seam created the warning.",
|
|
18896
|
+
format: "date-time",
|
|
18897
|
+
type: "string"
|
|
18898
|
+
},
|
|
18899
|
+
message: {
|
|
18900
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
18901
|
+
type: "string"
|
|
18902
|
+
},
|
|
18903
|
+
warning_code: {
|
|
18904
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
18905
|
+
enum: ["being_deleted"],
|
|
18906
|
+
type: "string"
|
|
18907
|
+
}
|
|
18908
|
+
},
|
|
18909
|
+
required: [
|
|
18910
|
+
"created_at",
|
|
18911
|
+
"message",
|
|
18912
|
+
"warning_code"
|
|
18913
|
+
],
|
|
18914
|
+
type: "object"
|
|
18915
|
+
},
|
|
18916
|
+
{
|
|
18917
|
+
description: "An unknown issue occurred while syncing the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) with the provider. This issue may affect the proper functioning of the credential.",
|
|
18918
|
+
properties: {
|
|
18919
|
+
created_at: {
|
|
18920
|
+
description: "Date and time at which Seam created the warning.",
|
|
18921
|
+
format: "date-time",
|
|
18922
|
+
type: "string"
|
|
18923
|
+
},
|
|
18924
|
+
message: {
|
|
18925
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
18926
|
+
type: "string"
|
|
18927
|
+
},
|
|
18928
|
+
warning_code: {
|
|
18929
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
18930
|
+
enum: ["unknown_issue_with_acs_credential"],
|
|
18931
|
+
type: "string"
|
|
18932
|
+
}
|
|
18933
|
+
},
|
|
18934
|
+
required: [
|
|
18935
|
+
"created_at",
|
|
18936
|
+
"message",
|
|
18937
|
+
"warning_code"
|
|
18938
|
+
],
|
|
18939
|
+
type: "object"
|
|
18940
|
+
},
|
|
18941
|
+
{
|
|
18942
|
+
description: "Access permissions for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) have changed. [Reissue](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials) (re-encode) the credential. This issue may affect the proper functioning of the credential.",
|
|
18943
|
+
properties: {
|
|
18944
|
+
created_at: {
|
|
18945
|
+
description: "Date and time at which Seam created the warning.",
|
|
18946
|
+
format: "date-time",
|
|
18947
|
+
type: "string"
|
|
18948
|
+
},
|
|
18949
|
+
message: {
|
|
18950
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
18951
|
+
type: "string"
|
|
18952
|
+
},
|
|
18953
|
+
warning_code: {
|
|
18954
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
18955
|
+
enum: ["needs_to_be_reissued"],
|
|
18956
|
+
type: "string"
|
|
18957
|
+
}
|
|
18958
|
+
},
|
|
18959
|
+
required: [
|
|
18960
|
+
"created_at",
|
|
18961
|
+
"message",
|
|
18962
|
+
"warning_code"
|
|
18963
|
+
],
|
|
18964
|
+
type: "object"
|
|
18965
|
+
}
|
|
18966
|
+
]
|
|
18967
|
+
},
|
|
18968
|
+
type: "array"
|
|
18969
|
+
},
|
|
18970
|
+
workspace_id: {
|
|
18971
|
+
description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
|
|
18972
|
+
format: "uuid",
|
|
18973
|
+
type: "string"
|
|
18974
|
+
}
|
|
18975
|
+
},
|
|
18976
|
+
required: [
|
|
18977
|
+
"acs_credential_id",
|
|
18978
|
+
"acs_system_id",
|
|
18979
|
+
"display_name",
|
|
18980
|
+
"access_method",
|
|
18981
|
+
"created_at",
|
|
18982
|
+
"workspace_id",
|
|
18983
|
+
"errors",
|
|
18984
|
+
"warnings",
|
|
18985
|
+
"is_managed",
|
|
18986
|
+
"acs_entrances"
|
|
18987
|
+
],
|
|
18988
|
+
type: "object",
|
|
18989
|
+
"x-route-path": "/acs/credentials"
|
|
18990
|
+
},
|
|
18991
|
+
type: "array"
|
|
18992
|
+
},
|
|
18993
|
+
phone_registration: {
|
|
18994
|
+
properties: {
|
|
18995
|
+
is_being_activated: { type: "boolean" },
|
|
18996
|
+
phone_registration_id: { type: "string" },
|
|
18997
|
+
provider_name: { nullable: true, type: "string" },
|
|
18998
|
+
provider_state: {}
|
|
18999
|
+
},
|
|
19000
|
+
required: [
|
|
19001
|
+
"phone_registration_id",
|
|
19002
|
+
"provider_name",
|
|
19003
|
+
"is_being_activated"
|
|
19004
|
+
],
|
|
19005
|
+
type: "object",
|
|
19006
|
+
"x-route-path": "/seam/mobile_sdk/v1/phone_sessions",
|
|
19007
|
+
"x-undocumented": "Seam Mobile SDK only."
|
|
19008
|
+
}
|
|
19009
|
+
},
|
|
19010
|
+
required: ["phone_registration", "acs_credentials"],
|
|
19011
|
+
type: "object"
|
|
19012
|
+
},
|
|
19013
|
+
type: "array"
|
|
19014
|
+
}
|
|
19015
|
+
},
|
|
19016
|
+
required: ["provider_sessions"],
|
|
19017
|
+
type: "object",
|
|
19018
|
+
"x-route-path": "/seam/mobile_sdk/v1/phone_sessions",
|
|
19019
|
+
"x-undocumented": "Seam Mobile SDK only."
|
|
19020
|
+
},
|
|
18455
19021
|
thermostat_schedule: {
|
|
18456
19022
|
description: "Represents a [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) that activates a configured [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) on a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) at a specified starting time and deactivates the climate preset at a specified ending time.",
|
|
18457
19023
|
properties: {
|
|
@@ -24323,12 +24889,17 @@ var openapi_default = {
|
|
|
24323
24889
|
type: "string"
|
|
24324
24890
|
},
|
|
24325
24891
|
acs_user_id: {
|
|
24326
|
-
description: "ID of the access system user to whom you want to assign a credential.",
|
|
24892
|
+
description: "ID of the access system user to whom you want to assign a credential. You can only provide one of acs_user_id or user_identity_id.",
|
|
24893
|
+
format: "uuid",
|
|
24894
|
+
type: "string"
|
|
24895
|
+
},
|
|
24896
|
+
user_identity_id: {
|
|
24897
|
+
description: "ID of the user identity to whom you want to assign a credential. You can only provide one of acs_user_id or user_identity_id. If the ACS system contains an ACS user with the same `email_address` or `phone_number` as the user identity that you specify, they are linked, and the credential belongs to the ACS user. If the ACS system does not have a corresponding ACS user, one is created.",
|
|
24327
24898
|
format: "uuid",
|
|
24328
24899
|
type: "string"
|
|
24329
24900
|
}
|
|
24330
24901
|
},
|
|
24331
|
-
required: ["
|
|
24902
|
+
required: ["acs_credential_id"],
|
|
24332
24903
|
type: "object"
|
|
24333
24904
|
}
|
|
24334
24905
|
}
|
|
@@ -24380,12 +24951,17 @@ var openapi_default = {
|
|
|
24380
24951
|
type: "string"
|
|
24381
24952
|
},
|
|
24382
24953
|
acs_user_id: {
|
|
24383
|
-
description: "ID of the access system user to whom you want to assign a credential.",
|
|
24954
|
+
description: "ID of the access system user to whom you want to assign a credential. You can only provide one of acs_user_id or user_identity_id.",
|
|
24955
|
+
format: "uuid",
|
|
24956
|
+
type: "string"
|
|
24957
|
+
},
|
|
24958
|
+
user_identity_id: {
|
|
24959
|
+
description: "ID of the user identity to whom you want to assign a credential. You can only provide one of acs_user_id or user_identity_id. If the ACS system contains an ACS user with the same `email_address` or `phone_number` as the user identity that you specify, they are linked, and the credential belongs to the ACS user. If the ACS system does not have a corresponding ACS user, one is created.",
|
|
24384
24960
|
format: "uuid",
|
|
24385
24961
|
type: "string"
|
|
24386
24962
|
}
|
|
24387
24963
|
},
|
|
24388
|
-
required: ["
|
|
24964
|
+
required: ["acs_credential_id"],
|
|
24389
24965
|
type: "object"
|
|
24390
24966
|
}
|
|
24391
24967
|
}
|
|
@@ -24968,12 +25544,17 @@ var openapi_default = {
|
|
|
24968
25544
|
type: "string"
|
|
24969
25545
|
},
|
|
24970
25546
|
acs_user_id: {
|
|
24971
|
-
description: "ID of the access system user from which you want to unassign a credential.",
|
|
25547
|
+
description: "ID of the access system user from which you want to unassign a credential. You can only provide one of acs_user_id or user_identity_id.",
|
|
25548
|
+
format: "uuid",
|
|
25549
|
+
type: "string"
|
|
25550
|
+
},
|
|
25551
|
+
user_identity_id: {
|
|
25552
|
+
description: "ID of the user identity from which you want to unassign a credential. You can only provide one of acs_user_id or user_identity_id.",
|
|
24972
25553
|
format: "uuid",
|
|
24973
25554
|
type: "string"
|
|
24974
25555
|
}
|
|
24975
25556
|
},
|
|
24976
|
-
required: ["
|
|
25557
|
+
required: ["acs_credential_id"],
|
|
24977
25558
|
type: "object"
|
|
24978
25559
|
}
|
|
24979
25560
|
}
|
|
@@ -25025,12 +25606,17 @@ var openapi_default = {
|
|
|
25025
25606
|
type: "string"
|
|
25026
25607
|
},
|
|
25027
25608
|
acs_user_id: {
|
|
25028
|
-
description: "ID of the access system user from which you want to unassign a credential.",
|
|
25609
|
+
description: "ID of the access system user from which you want to unassign a credential. You can only provide one of acs_user_id or user_identity_id.",
|
|
25610
|
+
format: "uuid",
|
|
25611
|
+
type: "string"
|
|
25612
|
+
},
|
|
25613
|
+
user_identity_id: {
|
|
25614
|
+
description: "ID of the user identity from which you want to unassign a credential. You can only provide one of acs_user_id or user_identity_id.",
|
|
25029
25615
|
format: "uuid",
|
|
25030
25616
|
type: "string"
|
|
25031
25617
|
}
|
|
25032
25618
|
},
|
|
25033
|
-
required: ["
|
|
25619
|
+
required: ["acs_credential_id"],
|
|
25034
25620
|
type: "object"
|
|
25035
25621
|
}
|
|
25036
25622
|
}
|
|
@@ -33094,6 +33680,64 @@ var openapi_default = {
|
|
|
33094
33680
|
"x-undocumented": "Mobile SDK only."
|
|
33095
33681
|
}
|
|
33096
33682
|
},
|
|
33683
|
+
"/seam/mobile_sdk/v1/phone_sessions/get_or_create": {
|
|
33684
|
+
post: {
|
|
33685
|
+
description: "Get or create a session for a mobile SDK phone.",
|
|
33686
|
+
operationId: "seamMobileSdkV1PhoneSessionsGetOrCreatePost",
|
|
33687
|
+
requestBody: {
|
|
33688
|
+
content: {
|
|
33689
|
+
"application/json": {
|
|
33690
|
+
schema: {
|
|
33691
|
+
properties: {
|
|
33692
|
+
custom_sdk_installation_id: { type: "string" },
|
|
33693
|
+
phone_device_metadata: {
|
|
33694
|
+
properties: {
|
|
33695
|
+
manufacturer: { type: "string" },
|
|
33696
|
+
model: { type: "string" },
|
|
33697
|
+
os_version: { type: "string" }
|
|
33698
|
+
},
|
|
33699
|
+
type: "object"
|
|
33700
|
+
},
|
|
33701
|
+
phone_os: { enum: ["ios", "android"], type: "string" }
|
|
33702
|
+
},
|
|
33703
|
+
required: ["custom_sdk_installation_id", "phone_os"],
|
|
33704
|
+
type: "object"
|
|
33705
|
+
}
|
|
33706
|
+
}
|
|
33707
|
+
}
|
|
33708
|
+
},
|
|
33709
|
+
responses: {
|
|
33710
|
+
200: {
|
|
33711
|
+
content: {
|
|
33712
|
+
"application/json": {
|
|
33713
|
+
schema: {
|
|
33714
|
+
properties: {
|
|
33715
|
+
ok: { type: "boolean" },
|
|
33716
|
+
phone_session: {
|
|
33717
|
+
$ref: "#/components/schemas/phone_session"
|
|
33718
|
+
}
|
|
33719
|
+
},
|
|
33720
|
+
required: ["phone_session", "ok"],
|
|
33721
|
+
type: "object"
|
|
33722
|
+
}
|
|
33723
|
+
}
|
|
33724
|
+
},
|
|
33725
|
+
description: "OK"
|
|
33726
|
+
},
|
|
33727
|
+
400: { description: "Bad Request" },
|
|
33728
|
+
401: { description: "Unauthorized" }
|
|
33729
|
+
},
|
|
33730
|
+
security: [{ client_session: [] }],
|
|
33731
|
+
summary: "/seam/mobile_sdk/v1/phone_sessions/get_or_create",
|
|
33732
|
+
tags: [],
|
|
33733
|
+
"x-fern-sdk-group-name": ["seam", "mobile_sdk", "v1", "phone_sessions"],
|
|
33734
|
+
"x-fern-sdk-method-name": "get_or_create",
|
|
33735
|
+
"x-fern-sdk-return-value": "phone_session",
|
|
33736
|
+
"x-response-key": "phone_session",
|
|
33737
|
+
"x-title": "Get or Create a Phone Session",
|
|
33738
|
+
"x-undocumented": "Mobile SDK only."
|
|
33739
|
+
}
|
|
33740
|
+
},
|
|
33097
33741
|
"/thermostats/activate_climate_preset": {
|
|
33098
33742
|
post: {
|
|
33099
33743
|
description: "Activates a specified [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).",
|