@seamapi/types 1.301.0 → 1.302.1

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.
Files changed (21) hide show
  1. package/dist/connect.cjs +87 -8
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +232 -29
  4. package/lib/seam/connect/models/devices/device-metadata.d.ts +5 -5
  5. package/lib/seam/connect/models/devices/device-metadata.js +1 -1
  6. package/lib/seam/connect/models/devices/device-metadata.js.map +1 -1
  7. package/lib/seam/connect/models/devices/device-provider.d.ts +1 -1
  8. package/lib/seam/connect/models/devices/device-provider.js +0 -1
  9. package/lib/seam/connect/models/devices/device-provider.js.map +1 -1
  10. package/lib/seam/connect/models/devices/device.d.ts +7 -7
  11. package/lib/seam/connect/models/devices/phone.d.ts +5 -5
  12. package/lib/seam/connect/models/devices/unmanaged-device.d.ts +5 -5
  13. package/lib/seam/connect/openapi.d.ts +96 -2
  14. package/lib/seam/connect/openapi.js +84 -4
  15. package/lib/seam/connect/openapi.js.map +1 -1
  16. package/lib/seam/connect/route-types.d.ts +124 -15
  17. package/package.json +1 -1
  18. package/src/lib/seam/connect/models/devices/device-metadata.ts +1 -1
  19. package/src/lib/seam/connect/models/devices/device-provider.ts +0 -1
  20. package/src/lib/seam/connect/openapi.ts +92 -4
  21. package/src/lib/seam/connect/route-types.ts +139 -15
package/lib/seam/connect/models/devices/phone.d.ts CHANGED
@@ -706,17 +706,17 @@ export declare const phone: z.ZodObject<z.objectUtil.extendShape<z.objectUtil.ex
706
706
  nest_metadata: z.ZodOptional<z.ZodObject<{
707
707
  nest_device_id: z.ZodString;
708
708
  device_name: z.ZodString;
709
- custom_name: z.ZodString;
709
+ device_custom_name: z.ZodString;
710
710
  display_name: z.ZodOptional<z.ZodString>;
711
711
  }, "strip", z.ZodTypeAny, {
712
712
  device_name: string;
713
713
  nest_device_id: string;
714
- custom_name: string;
714
+ device_custom_name: string;
715
715
  display_name?: string | undefined;
716
716
  }, {
717
717
  device_name: string;
718
718
  nest_device_id: string;
719
- custom_name: string;
719
+ device_custom_name: string;
720
720
  display_name?: string | undefined;
721
721
  }>>;
722
722
  ecobee_metadata: z.ZodOptional<z.ZodObject<{
@@ -1073,7 +1073,7 @@ export declare const phone: z.ZodObject<z.objectUtil.extendShape<z.objectUtil.ex
1073
1073
  nest_metadata?: {
1074
1074
  device_name: string;
1075
1075
  nest_device_id: string;
1076
- custom_name: string;
1076
+ device_custom_name: string;
1077
1077
  display_name?: string | undefined;
1078
1078
  } | undefined;
1079
1079
  ecobee_metadata?: {
@@ -1296,7 +1296,7 @@ export declare const phone: z.ZodObject<z.objectUtil.extendShape<z.objectUtil.ex
1296
1296
  nest_metadata?: {
1297
1297
  device_name: string;
1298
1298
  nest_device_id: string;
1299
- custom_name: string;
1299
+ device_custom_name: string;
1300
1300
  display_name?: string | undefined;
1301
1301
  } | undefined;
1302
1302
  ecobee_metadata?: {
package/lib/seam/connect/models/devices/unmanaged-device.d.ts CHANGED
@@ -705,17 +705,17 @@ export declare const unmanaged_device: z.ZodObject<z.objectUtil.extendShape<z.ob
705
705
  nest_metadata: z.ZodOptional<z.ZodObject<{
706
706
  nest_device_id: z.ZodString;
707
707
  device_name: z.ZodString;
708
- custom_name: z.ZodString;
708
+ device_custom_name: z.ZodString;
709
709
  display_name: z.ZodOptional<z.ZodString>;
710
710
  }, "strip", z.ZodTypeAny, {
711
711
  device_name: string;
712
712
  nest_device_id: string;
713
- custom_name: string;
713
+ device_custom_name: string;
714
714
  display_name?: string | undefined;
715
715
  }, {
716
716
  device_name: string;
717
717
  nest_device_id: string;
718
- custom_name: string;
718
+ device_custom_name: string;
719
719
  display_name?: string | undefined;
720
720
  }>>;
721
721
  ecobee_metadata: z.ZodOptional<z.ZodObject<{
@@ -1072,7 +1072,7 @@ export declare const unmanaged_device: z.ZodObject<z.objectUtil.extendShape<z.ob
1072
1072
  nest_metadata?: {
1073
1073
  device_name: string;
1074
1074
  nest_device_id: string;
1075
- custom_name: string;
1075
+ device_custom_name: string;
1076
1076
  display_name?: string | undefined;
1077
1077
  } | undefined;
1078
1078
  ecobee_metadata?: {
@@ -1295,7 +1295,7 @@ export declare const unmanaged_device: z.ZodObject<z.objectUtil.extendShape<z.ob
1295
1295
  nest_metadata?: {
1296
1296
  device_name: string;
1297
1297
  nest_device_id: string;
1298
- custom_name: string;
1298
+ device_custom_name: string;
1299
1299
  display_name?: string | undefined;
1300
1300
  } | undefined;
1301
1301
  ecobee_metadata?: {
package/lib/seam/connect/openapi.d.ts CHANGED
@@ -2905,7 +2905,7 @@ declare const _default: {
2905
2905
  };
2906
2906
  nest_metadata: {
2907
2907
  properties: {
2908
- custom_name: {
2908
+ device_custom_name: {
2909
2909
  type: string;
2910
2910
  };
2911
2911
  device_name: {
@@ -7922,9 +7922,11 @@ declare const _default: {
7922
7922
  description: string;
7923
7923
  properties: {
7924
7924
  assa_abloy_credential_service_mobile_endpoint_id: {
7925
- description: string;
7925
+ deprecated: boolean;
7926
7926
  format: string;
7927
7927
  type: string;
7928
+ 'x-deprecated': string;
7929
+ 'x-undocumented': string;
7928
7930
  };
7929
7931
  auto_join: {
7930
7932
  type: string;
@@ -7942,6 +7944,7 @@ declare const _default: {
7942
7944
  deprecated: boolean;
7943
7945
  type: string;
7944
7946
  'x-deprecated': string;
7947
+ 'x-undocumented': string;
7945
7948
  };
7946
7949
  joiner_acs_credential_ids: {
7947
7950
  items: {
@@ -8012,6 +8015,97 @@ declare const _default: {
8012
8015
  'x-title': string;
8013
8016
  };
8014
8017
  };
8018
+ '/acs/credentials/create_offline_code': {
8019
+ post: {
8020
+ description: string;
8021
+ operationId: string;
8022
+ requestBody: {
8023
+ content: {
8024
+ 'application/json': {
8025
+ schema: {
8026
+ properties: {
8027
+ acs_user_id: {
8028
+ description: string;
8029
+ format: string;
8030
+ type: string;
8031
+ };
8032
+ allowed_acs_entrance_id: {
8033
+ description: string;
8034
+ format: string;
8035
+ type: string;
8036
+ };
8037
+ ends_at: {
8038
+ description: string;
8039
+ format: string;
8040
+ type: string;
8041
+ };
8042
+ is_one_time_use: {
8043
+ default: boolean;
8044
+ description: string;
8045
+ type: string;
8046
+ };
8047
+ starts_at: {
8048
+ description: string;
8049
+ format: string;
8050
+ type: string;
8051
+ };
8052
+ };
8053
+ required: string[];
8054
+ type: string;
8055
+ };
8056
+ };
8057
+ };
8058
+ };
8059
+ responses: {
8060
+ 200: {
8061
+ content: {
8062
+ 'application/json': {
8063
+ schema: {
8064
+ properties: {
8065
+ acs_credential: {
8066
+ $ref: string;
8067
+ };
8068
+ ok: {
8069
+ type: string;
8070
+ };
8071
+ };
8072
+ required: string[];
8073
+ type: string;
8074
+ };
8075
+ };
8076
+ };
8077
+ description: string;
8078
+ };
8079
+ 400: {
8080
+ description: string;
8081
+ };
8082
+ 401: {
8083
+ description: string;
8084
+ };
8085
+ };
8086
+ security: ({
8087
+ pat_with_workspace: never[];
8088
+ console_session?: never;
8089
+ api_key?: never;
8090
+ } | {
8091
+ console_session: never[];
8092
+ pat_with_workspace?: never;
8093
+ api_key?: never;
8094
+ } | {
8095
+ api_key: never[];
8096
+ pat_with_workspace?: never;
8097
+ console_session?: never;
8098
+ })[];
8099
+ summary: string;
8100
+ tags: string[];
8101
+ 'x-fern-sdk-group-name': string[];
8102
+ 'x-fern-sdk-method-name': string;
8103
+ 'x-fern-sdk-return-value': string;
8104
+ 'x-response-key': string;
8105
+ 'x-title': string;
8106
+ 'x-undocumented': string;
8107
+ };
8108
+ };
8015
8109
  '/acs/credentials/delete': {
8016
8110
  post: {
8017
8111
  description: string;
package/lib/seam/connect/openapi.js CHANGED
@@ -4601,7 +4601,7 @@ export default {
4601
4601
  },
4602
4602
  nest_metadata: {
4603
4603
  properties: {
4604
- custom_name: { type: 'string' },
4604
+ device_custom_name: { type: 'string' },
4605
4605
  device_name: { type: 'string' },
4606
4606
  display_name: { type: 'string' },
4607
4607
  nest_device_id: { type: 'string' },
@@ -4609,7 +4609,7 @@ export default {
4609
4609
  required: [
4610
4610
  'nest_device_id',
4611
4611
  'device_name',
4612
- 'custom_name',
4612
+ 'device_custom_name',
4613
4613
  ],
4614
4614
  type: 'object',
4615
4615
  },
@@ -8494,9 +8494,11 @@ export default {
8494
8494
  description: 'Visionline-specific metadata for the new credential.',
8495
8495
  properties: {
8496
8496
  assa_abloy_credential_service_mobile_endpoint_id: {
8497
- description: 'DEPRECATED: DO NOT USE',
8497
+ deprecated: true,
8498
8498
  format: 'uuid',
8499
8499
  type: 'string',
8500
+ 'x-deprecated': 'Read-only endpoint references moved to `endpoint`.',
8501
+ 'x-undocumented': 'Deprecated. Read-only endpoint references moved to `endpoint`.',
8500
8502
  },
8501
8503
  auto_join: { type: 'boolean' },
8502
8504
  card_format: {
@@ -8511,7 +8513,8 @@ export default {
8511
8513
  is_override_key: {
8512
8514
  deprecated: true,
8513
8515
  type: 'boolean',
8514
- 'x-deprecated': 'use override.',
8516
+ 'x-deprecated': 'Use `override` instead.',
8517
+ 'x-undocumented': 'Use `override` instead.',
8515
8518
  },
8516
8519
  joiner_acs_credential_ids: {
8517
8520
  items: { format: 'uuid', type: 'string' },
@@ -8563,6 +8566,83 @@ export default {
8563
8566
  'x-title': 'Create a Credential for an ACS User',
8564
8567
  },
8565
8568
  },
8569
+ '/acs/credentials/create_offline_code': {
8570
+ post: {
8571
+ description: 'Creates a new offline [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) for a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
8572
+ operationId: 'acsCredentialsCreateOfflineCodePost',
8573
+ requestBody: {
8574
+ content: {
8575
+ 'application/json': {
8576
+ schema: {
8577
+ properties: {
8578
+ acs_user_id: {
8579
+ description: 'ID of the ACS user to whom the new credential belongs.',
8580
+ format: 'uuid',
8581
+ type: 'string',
8582
+ },
8583
+ allowed_acs_entrance_id: {
8584
+ description: 'IDs of the [`acs_entrance`s](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) for which the new credential grants access.',
8585
+ format: 'uuid',
8586
+ type: 'string',
8587
+ },
8588
+ ends_at: {
8589
+ description: 'Date and time at which the validity of the new credential 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`.',
8590
+ format: 'date-time',
8591
+ type: 'string',
8592
+ },
8593
+ is_one_time_use: {
8594
+ default: false,
8595
+ description: 'Indicates whether the code is one-time-use or reusable.',
8596
+ type: 'boolean',
8597
+ },
8598
+ starts_at: {
8599
+ description: 'Date and time at which the validity of the new credential starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
8600
+ format: 'date-time',
8601
+ type: 'string',
8602
+ },
8603
+ },
8604
+ required: ['acs_user_id'],
8605
+ type: 'object',
8606
+ },
8607
+ },
8608
+ },
8609
+ },
8610
+ responses: {
8611
+ 200: {
8612
+ content: {
8613
+ 'application/json': {
8614
+ schema: {
8615
+ properties: {
8616
+ acs_credential: {
8617
+ $ref: '#/components/schemas/acs_credential',
8618
+ },
8619
+ ok: { type: 'boolean' },
8620
+ },
8621
+ required: ['acs_credential', 'ok'],
8622
+ type: 'object',
8623
+ },
8624
+ },
8625
+ },
8626
+ description: 'OK',
8627
+ },
8628
+ 400: { description: 'Bad Request' },
8629
+ 401: { description: 'Unauthorized' },
8630
+ },
8631
+ security: [
8632
+ { pat_with_workspace: [] },
8633
+ { console_session: [] },
8634
+ { api_key: [] },
8635
+ ],
8636
+ summary: '/acs/credentials/create_offline_code',
8637
+ tags: ['/acs'],
8638
+ 'x-fern-sdk-group-name': ['acs', 'credentials'],
8639
+ 'x-fern-sdk-method-name': 'create_offline_code',
8640
+ 'x-fern-sdk-return-value': 'acs_credential',
8641
+ 'x-response-key': 'acs_credential',
8642
+ 'x-title': 'Create an Offline Credential for an ACS User',
8643
+ 'x-undocumented': 'Unreleased.',
8644
+ },
8645
+ },
8566
8646
  '/acs/credentials/delete': {
8567
8647
  post: {
8568
8648
  description: 'Deletes a specified [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',