@seamapi/types 1.410.2 → 1.411.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.
@@ -56841,7 +56841,7 @@ export interface Routes {
56841
56841
  /** */
56842
56842
  magic_link: {
56843
56843
  url: string;
56844
- building_block_type: 'connect_accounts' | 'manage_devices' | 'organize_spaces';
56844
+ building_block_type: 'connect_accounts' | 'manage_devices' | 'organize_spaces' | 'console';
56845
56845
  customer_key: string;
56846
56846
  expires_at: string;
56847
56847
  workspace_id: string;
@@ -56855,23 +56855,13 @@ export interface Routes {
56855
56855
  queryParams: {};
56856
56856
  jsonBody: {};
56857
56857
  commonParams: {
56858
- /** `connect_accounts` building block type. */
56859
- building_block_type: 'connect_accounts';
56858
+ /** Type of building block to create a magic link for. */
56859
+ building_block_type: 'connect_accounts' | 'organize_spaces' | 'console' | 'manage_devices';
56860
56860
  /** Customer key for which you want to create a new building block magic link. */
56861
56861
  customer_key: string;
56862
- } | {
56863
- /** `manage_devices` building block type. */
56864
- building_block_type: 'manage_devices';
56865
- /** Customer key for which you want to create a new building block magic link. */
56866
- customer_key: string;
56867
- } | {
56868
- /** `organize_spaces` building block type. */
56869
- building_block_type: 'organize_spaces';
56870
- /** Customer key for which you want to create a new building block magic link. */
56871
- customer_key: string;
56872
- /** Optional list of partner resources that you want to include in the new building block magic link. */
56873
- partner_resources?: Array<{
56874
- partner_resource_key: string;
56862
+ /** Optional list of spaces that you want to include in the new building block magic link. */
56863
+ spaces?: Array<{
56864
+ space_key: string;
56875
56865
  name: string;
56876
56866
  description?: string | undefined;
56877
56867
  custom_metadata?: Record<string, string> | undefined;
@@ -56882,7 +56872,7 @@ export interface Routes {
56882
56872
  /** */
56883
56873
  magic_link: {
56884
56874
  url: string;
56885
- building_block_type: 'connect_accounts' | 'manage_devices' | 'organize_spaces';
56875
+ building_block_type: 'connect_accounts' | 'manage_devices' | 'organize_spaces' | 'console';
56886
56876
  customer_key: string;
56887
56877
  expires_at: string;
56888
56878
  workspace_id: string;
@@ -56904,7 +56894,7 @@ export interface Routes {
56904
56894
  /** */
56905
56895
  magic_link: {
56906
56896
  url: string;
56907
- building_block_type: 'connect_accounts' | 'manage_devices' | 'organize_spaces';
56897
+ building_block_type: 'connect_accounts' | 'manage_devices' | 'organize_spaces' | 'console';
56908
56898
  customer_key: string;
56909
56899
  expires_at: string;
56910
56900
  workspace_id: string;
@@ -56920,9 +56910,9 @@ export interface Routes {
56920
56910
  commonParams: {
56921
56911
  /** Customer key for which you want to organize spaces. */
56922
56912
  customer_key: string;
56923
- /** Optional list of partner resources that you want to include in the new building block magic link. */
56924
- partner_resources?: Array<{
56925
- partner_resource_key: string;
56913
+ /** Optional list of spaces that you want to include in the new building block magic link. */
56914
+ spaces?: Array<{
56915
+ space_key: string;
56926
56916
  name: string;
56927
56917
  description?: string | undefined;
56928
56918
  custom_metadata?: Record<string, string> | undefined;
@@ -56933,7 +56923,7 @@ export interface Routes {
56933
56923
  /** */
56934
56924
  magic_link: {
56935
56925
  url: string;
56936
- building_block_type: 'connect_accounts' | 'manage_devices' | 'organize_spaces';
56926
+ building_block_type: 'connect_accounts' | 'manage_devices' | 'organize_spaces' | 'console';
56937
56927
  customer_key: string;
56938
56928
  expires_at: string;
56939
56929
  workspace_id: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.410.2",
3
+ "version": "1.411.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -54,6 +54,7 @@ export {
54
54
  phone_registration,
55
55
  phone_session,
56
56
  space,
57
+ space_resource,
57
58
  thermostat_capability_properties,
58
59
  thermostat_device_type,
59
60
  thermostat_schedule,
@@ -4,6 +4,7 @@ export const building_block_type = z.enum([
4
4
  'connect_accounts',
5
5
  'manage_devices',
6
6
  'organize_spaces',
7
+ 'console',
7
8
  ])
8
9
 
9
10
  export type BuildingBlockType = z.infer<typeof building_block_type>
@@ -42,3 +42,18 @@ export const typed_partner_resource = z.object({
42
42
  `)
43
43
 
44
44
  export type TypedPartnerResource = z.infer<typeof typed_partner_resource>
45
+
46
+ export const space_resource = z.object({
47
+ space_key: z.string(),
48
+
49
+ name: z.string(),
50
+ description: z.string().optional(),
51
+ custom_metadata: z.record(z.string(), z.string()).optional(),
52
+ }).describe(`
53
+ ---
54
+ undocumented: Unreleased.
55
+ route_path: /unstable_partner/resources
56
+ ---
57
+ `)
58
+
59
+ export type SpaceResource = z.infer<typeof space_resource>
@@ -15970,7 +15970,12 @@ export default {
15970
15970
  magic_link: {
15971
15971
  properties: {
15972
15972
  building_block_type: {
15973
- enum: ['connect_accounts', 'manage_devices', 'organize_spaces'],
15973
+ enum: [
15974
+ 'connect_accounts',
15975
+ 'manage_devices',
15976
+ 'organize_spaces',
15977
+ 'console',
15978
+ ],
15974
15979
  type: 'string',
15975
15980
  },
15976
15981
  created_at: { format: 'date-time', type: 'string' },
@@ -39881,76 +39886,46 @@ export default {
39881
39886
  content: {
39882
39887
  'application/json': {
39883
39888
  schema: {
39884
- oneOf: [
39885
- {
39886
- properties: {
39887
- building_block_type: {
39888
- description: '`connect_accounts` building block type.',
39889
- enum: ['connect_accounts'],
39890
- type: 'string',
39891
- },
39892
- customer_key: {
39893
- description:
39894
- 'Customer key for which you want to create a new building block magic link.',
39895
- type: 'string',
39896
- },
39897
- },
39898
- required: ['building_block_type', 'customer_key'],
39899
- type: 'object',
39889
+ properties: {
39890
+ building_block_type: {
39891
+ description:
39892
+ 'Type of building block to create a magic link for.',
39893
+ enum: [
39894
+ 'connect_accounts',
39895
+ 'organize_spaces',
39896
+ 'console',
39897
+ 'manage_devices',
39898
+ ],
39899
+ type: 'string',
39900
39900
  },
39901
- {
39902
- properties: {
39903
- building_block_type: {
39904
- description: '`manage_devices` building block type.',
39905
- enum: ['manage_devices'],
39906
- type: 'string',
39907
- },
39908
- customer_key: {
39909
- description:
39910
- 'Customer key for which you want to create a new building block magic link.',
39911
- type: 'string',
39912
- },
39913
- },
39914
- required: ['building_block_type', 'customer_key'],
39915
- type: 'object',
39901
+ customer_key: {
39902
+ description:
39903
+ 'Customer key for which you want to create a new building block magic link.',
39904
+ type: 'string',
39916
39905
  },
39917
- {
39918
- properties: {
39919
- building_block_type: {
39920
- description: '`organize_spaces` building block type.',
39921
- enum: ['organize_spaces'],
39922
- type: 'string',
39923
- },
39924
- customer_key: {
39925
- description:
39926
- 'Customer key for which you want to create a new building block magic link.',
39927
- type: 'string',
39928
- },
39929
- partner_resources: {
39930
- description:
39931
- 'Optional list of partner resources that you want to include in the new building block magic link.',
39932
- items: {
39933
- properties: {
39934
- custom_metadata: {
39935
- additionalProperties: { type: 'string' },
39936
- type: 'object',
39937
- },
39938
- description: { type: 'string' },
39939
- name: { type: 'string' },
39940
- partner_resource_key: { type: 'string' },
39941
- },
39942
- required: ['partner_resource_key', 'name'],
39906
+ spaces: {
39907
+ description:
39908
+ 'Optional list of spaces that you want to include in the new building block magic link.',
39909
+ items: {
39910
+ properties: {
39911
+ custom_metadata: {
39912
+ additionalProperties: { type: 'string' },
39943
39913
  type: 'object',
39944
- 'x-route-path': '/unstable_partner/resources',
39945
- 'x-undocumented': 'Unreleased.',
39946
39914
  },
39947
- type: 'array',
39915
+ description: { type: 'string' },
39916
+ name: { type: 'string' },
39917
+ space_key: { type: 'string' },
39948
39918
  },
39919
+ required: ['space_key', 'name'],
39920
+ type: 'object',
39921
+ 'x-route-path': '/unstable_partner/resources',
39922
+ 'x-undocumented': 'Unreleased.',
39949
39923
  },
39950
- required: ['building_block_type', 'customer_key'],
39951
- type: 'object',
39924
+ type: 'array',
39952
39925
  },
39953
- ],
39926
+ },
39927
+ required: ['building_block_type', 'customer_key'],
39928
+ type: 'object',
39954
39929
  },
39955
39930
  },
39956
39931
  },
@@ -40060,9 +40035,9 @@ export default {
40060
40035
  'Customer key for which you want to organize spaces.',
40061
40036
  type: 'string',
40062
40037
  },
40063
- partner_resources: {
40038
+ spaces: {
40064
40039
  description:
40065
- 'Optional list of partner resources that you want to include in the new building block magic link.',
40040
+ 'Optional list of spaces that you want to include in the new building block magic link.',
40066
40041
  items: {
40067
40042
  properties: {
40068
40043
  custom_metadata: {
@@ -40071,9 +40046,9 @@ export default {
40071
40046
  },
40072
40047
  description: { type: 'string' },
40073
40048
  name: { type: 'string' },
40074
- partner_resource_key: { type: 'string' },
40049
+ space_key: { type: 'string' },
40075
40050
  },
40076
- required: ['partner_resource_key', 'name'],
40051
+ required: ['space_key', 'name'],
40077
40052
  type: 'object',
40078
40053
  'x-route-path': '/unstable_partner/resources',
40079
40054
  'x-undocumented': 'Unreleased.',
@@ -66814,6 +66814,7 @@ export interface Routes {
66814
66814
  | 'connect_accounts'
66815
66815
  | 'manage_devices'
66816
66816
  | 'organize_spaces'
66817
+ | 'console'
66817
66818
  customer_key: string
66818
66819
  expires_at: string
66819
66820
  workspace_id: string
@@ -66826,34 +66827,25 @@ export interface Routes {
66826
66827
  method: 'POST' | 'GET'
66827
66828
  queryParams: {}
66828
66829
  jsonBody: {}
66829
- commonParams:
66830
- | {
66831
- /** `connect_accounts` building block type. */
66832
- building_block_type: 'connect_accounts'
66833
- /** Customer key for which you want to create a new building block magic link. */
66834
- customer_key: string
66835
- }
66836
- | {
66837
- /** `manage_devices` building block type. */
66838
- building_block_type: 'manage_devices'
66839
- /** Customer key for which you want to create a new building block magic link. */
66840
- customer_key: string
66841
- }
66842
- | {
66843
- /** `organize_spaces` building block type. */
66844
- building_block_type: 'organize_spaces'
66845
- /** Customer key for which you want to create a new building block magic link. */
66846
- customer_key: string
66847
- /** Optional list of partner resources that you want to include in the new building block magic link. */
66848
- partner_resources?:
66849
- | Array<{
66850
- partner_resource_key: string
66851
- name: string
66852
- description?: string | undefined
66853
- custom_metadata?: Record<string, string> | undefined
66854
- }>
66855
- | undefined
66856
- }
66830
+ commonParams: {
66831
+ /** Type of building block to create a magic link for. */
66832
+ building_block_type:
66833
+ | 'connect_accounts'
66834
+ | 'organize_spaces'
66835
+ | 'console'
66836
+ | 'manage_devices'
66837
+ /** Customer key for which you want to create a new building block magic link. */
66838
+ customer_key: string
66839
+ /** Optional list of spaces that you want to include in the new building block magic link. */
66840
+ spaces?:
66841
+ | Array<{
66842
+ space_key: string
66843
+ name: string
66844
+ description?: string | undefined
66845
+ custom_metadata?: Record<string, string> | undefined
66846
+ }>
66847
+ | undefined
66848
+ }
66857
66849
  formData: {}
66858
66850
  jsonResponse: {
66859
66851
  /** */
@@ -66863,6 +66855,7 @@ export interface Routes {
66863
66855
  | 'connect_accounts'
66864
66856
  | 'manage_devices'
66865
66857
  | 'organize_spaces'
66858
+ | 'console'
66866
66859
  customer_key: string
66867
66860
  expires_at: string
66868
66861
  workspace_id: string
@@ -66888,6 +66881,7 @@ export interface Routes {
66888
66881
  | 'connect_accounts'
66889
66882
  | 'manage_devices'
66890
66883
  | 'organize_spaces'
66884
+ | 'console'
66891
66885
  customer_key: string
66892
66886
  expires_at: string
66893
66887
  workspace_id: string
@@ -66903,10 +66897,10 @@ export interface Routes {
66903
66897
  commonParams: {
66904
66898
  /** Customer key for which you want to organize spaces. */
66905
66899
  customer_key: string
66906
- /** Optional list of partner resources that you want to include in the new building block magic link. */
66907
- partner_resources?:
66900
+ /** Optional list of spaces that you want to include in the new building block magic link. */
66901
+ spaces?:
66908
66902
  | Array<{
66909
- partner_resource_key: string
66903
+ space_key: string
66910
66904
  name: string
66911
66905
  description?: string | undefined
66912
66906
  custom_metadata?: Record<string, string> | undefined
@@ -66922,6 +66916,7 @@ export interface Routes {
66922
66916
  | 'connect_accounts'
66923
66917
  | 'manage_devices'
66924
66918
  | 'organize_spaces'
66919
+ | 'console'
66925
66920
  customer_key: string
66926
66921
  expires_at: string
66927
66922
  workspace_id: string