@seamapi/types 1.129.0 → 1.131.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
@@ -642,6 +642,10 @@ var openapi_default = {
642
642
  { enum: ["ios_phone", "android_phone"], type: "string" }
643
643
  ]
644
644
  },
645
+ display_name: {
646
+ description: "Display name of the device, defaults to nickname (if it is set) or properties.appearance.name otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices.",
647
+ type: "string"
648
+ },
645
649
  errors: {
646
650
  description: 'Array of errors associated with the device. Each error object within the array contains two fields: "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.',
647
651
  items: {
@@ -674,6 +678,10 @@ var openapi_default = {
674
678
  },
675
679
  type: "object"
676
680
  },
681
+ nickname: {
682
+ description: "Optional nickname to describe the device, settable through Seam",
683
+ type: "string"
684
+ },
677
685
  properties: {
678
686
  allOf: [
679
687
  {
@@ -682,6 +690,16 @@ var openapi_default = {
682
690
  allOf: [
683
691
  {
684
692
  properties: {
693
+ appearance: {
694
+ properties: {
695
+ name: {
696
+ description: "Name of the device as seen from the provider API and application, not settable through Seam.",
697
+ type: "string"
698
+ }
699
+ },
700
+ required: ["name"],
701
+ type: "object"
702
+ },
685
703
  battery: {
686
704
  description: 'Represents the current status of the battery charge level. Values are "critical," which indicates an extremely low level, suggesting imminent shutdown or an urgent need for charging; "low," which signifies that the battery is under the preferred threshold and should be charged soon; "good," which denotes a satisfactory charge level, adequate for normal use without the immediate need for recharging; and "full," which represents a battery that is fully charged, providing the maximum duration of usage.',
687
705
  properties: {
@@ -747,7 +765,7 @@ var openapi_default = {
747
765
  type: "object"
748
766
  },
749
767
  name: {
750
- description: "Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices.",
768
+ description: "Name of the device. Deprecated - use device.display_name instead",
751
769
  type: "string"
752
770
  },
753
771
  offline_access_codes_enabled: {
@@ -775,7 +793,7 @@ var openapi_default = {
775
793
  type: "boolean"
776
794
  }
777
795
  },
778
- required: ["online", "name", "model"],
796
+ required: ["online", "name", "appearance", "model"],
779
797
  type: "object"
780
798
  },
781
799
  {
@@ -1716,6 +1734,7 @@ var openapi_default = {
1716
1734
  required: [
1717
1735
  "device_id",
1718
1736
  "device_type",
1737
+ "display_name",
1719
1738
  "capabilities_supported",
1720
1739
  "properties",
1721
1740
  "location",
@@ -1891,6 +1910,10 @@ var openapi_default = {
1891
1910
  type: "string"
1892
1911
  },
1893
1912
  device_type: { enum: ["android_phone", "ios_phone"], type: "string" },
1913
+ display_name: {
1914
+ description: "Display name of the device, defaults to nickname (if it is set) or properties.appearance.name otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices.",
1915
+ type: "string"
1916
+ },
1894
1917
  errors: {
1895
1918
  description: 'Array of errors associated with the device. Each error object within the array contains two fields: "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.',
1896
1919
  items: {
@@ -1923,6 +1946,10 @@ var openapi_default = {
1923
1946
  },
1924
1947
  type: "object"
1925
1948
  },
1949
+ nickname: {
1950
+ description: "Optional nickname to describe the device, settable through Seam",
1951
+ type: "string"
1952
+ },
1926
1953
  properties: {
1927
1954
  properties: {
1928
1955
  assa_abloy_credential_service_metadata: {
@@ -1967,6 +1994,7 @@ var openapi_default = {
1967
1994
  required: [
1968
1995
  "device_id",
1969
1996
  "device_type",
1997
+ "display_name",
1970
1998
  "capabilities_supported",
1971
1999
  "properties",
1972
2000
  "location",
@@ -2210,7 +2238,7 @@ var openapi_default = {
2210
2238
  type: "object"
2211
2239
  },
2212
2240
  name: {
2213
- description: "Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices.",
2241
+ description: "Name of the device. Deprecated - use device.display_name instead",
2214
2242
  type: "string"
2215
2243
  },
2216
2244
  offline_access_codes_enabled: {
@@ -9180,9 +9208,10 @@ var openapi_default = {
9180
9208
  401: { description: "Unauthorized" }
9181
9209
  },
9182
9210
  security: [
9183
- { access_token: [], seam_workspace: [] },
9184
- { seam_client_session_token: [] },
9185
- { client_session_token: [] }
9211
+ { client_session: [] },
9212
+ { pat_with_workspace: [] },
9213
+ { console_session: [] },
9214
+ { api_key: [] }
9186
9215
  ],
9187
9216
  summary: "/locks/unlock_door",
9188
9217
  tags: ["/locks"],