@seamapi/types 1.641.0 → 1.643.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.
@@ -57456,23 +57456,40 @@ export type Routes = {
57456
57456
  formData: {};
57457
57457
  jsonResponse: {};
57458
57458
  };
57459
+ '/seam/customer/v1/connectors/connector_types': {
57460
+ route: '/seam/customer/v1/connectors/connector_types';
57461
+ method: 'GET' | 'POST';
57462
+ queryParams: {};
57463
+ jsonBody: {};
57464
+ commonParams: {};
57465
+ formData: {};
57466
+ jsonResponse: {
57467
+ connector_types: {
57468
+ connector_type: string;
57469
+ display_name: string;
57470
+ description?: string | undefined;
57471
+ instance_config_schema?: any;
57472
+ static_config: {
57473
+ base_api_url: string;
57474
+ polling_enabled: boolean;
57475
+ polling_frequency_minutes: number;
57476
+ };
57477
+ }[];
57478
+ };
57479
+ };
57459
57480
  '/seam/customer/v1/connectors/create': {
57460
57481
  route: '/seam/customer/v1/connectors/create';
57461
57482
  method: 'POST';
57462
57483
  queryParams: {};
57463
57484
  jsonBody: {
57464
57485
  /** Type of connector to create */
57465
- connector_type: 'mews' | 'mock';
57486
+ connector_type: 'mock' | 'mews' | 'rms';
57466
57487
  /** Key identifying the customer */
57467
57488
  customer_key?: string | undefined;
57468
57489
  /** Instance-specific configuration for the connector */
57469
57490
  config: {
57470
- client_token?: string | undefined;
57471
- access_token?: string | undefined;
57472
- client?: string;
57473
- enterprise_ids?: string[] | undefined;
57474
- enterprise_id?: string | undefined;
57475
- } | {};
57491
+ [x: string]: unknown;
57492
+ };
57476
57493
  };
57477
57494
  commonParams: {};
57478
57495
  formData: {};
@@ -57557,13 +57574,20 @@ export type Routes = {
57557
57574
  /** Key identifying the customer */
57558
57575
  customer_key?: string | undefined;
57559
57576
  /** Instance-specific configuration for the connector */
57560
- config: {
57577
+ config: {} | {
57561
57578
  client_token?: string | undefined;
57562
57579
  access_token?: string | undefined;
57563
57580
  client?: string;
57564
57581
  enterprise_ids?: string[] | undefined;
57565
57582
  enterprise_id?: string | undefined;
57566
- } | {};
57583
+ } | {
57584
+ /** RMS client ID for authentication */
57585
+ client_id: string;
57586
+ /** RMS client password for authentication */
57587
+ client_password: string;
57588
+ /** Optional property ID for single-property connectors */
57589
+ property_id?: (string | number) | undefined;
57590
+ };
57567
57591
  };
57568
57592
  commonParams: {};
57569
57593
  formData: {};
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.641.0",
3
+ "version": "1.643.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -8,10 +8,12 @@ const base_access_grant_resource = z.object({
8
8
  .describe('Your name for this access grant resource.'),
9
9
  starts_at: z
10
10
  .string()
11
+ .datetime()
11
12
  .optional()
12
13
  .describe('Starting date and time for the access grant.'),
13
14
  ends_at: z
14
15
  .string()
16
+ .datetime()
15
17
  .optional()
16
18
  .describe('Ending date and time for the access grant.'),
17
19
  preferred_code: z
@@ -41486,6 +41486,7 @@ export default {
41486
41486
  ends_at: {
41487
41487
  description:
41488
41488
  'Ending date and time for the access grant.',
41489
+ format: 'date-time',
41489
41490
  type: 'string',
41490
41491
  },
41491
41492
  facility_keys: {
@@ -41541,6 +41542,7 @@ export default {
41541
41542
  starts_at: {
41542
41543
  description:
41543
41544
  'Starting date and time for the access grant.',
41545
+ format: 'date-time',
41544
41546
  type: 'string',
41545
41547
  },
41546
41548
  tenant_key: {
@@ -41595,6 +41597,7 @@ export default {
41595
41597
  ends_at: {
41596
41598
  description:
41597
41599
  'Ending date and time for the access grant.',
41600
+ format: 'date-time',
41598
41601
  type: 'string',
41599
41602
  },
41600
41603
  facility_keys: {
@@ -41650,6 +41653,7 @@ export default {
41650
41653
  starts_at: {
41651
41654
  description:
41652
41655
  'Starting date and time for the access grant.',
41656
+ format: 'date-time',
41653
41657
  type: 'string',
41654
41658
  },
41655
41659
  tenant_key: {
@@ -41868,6 +41872,7 @@ export default {
41868
41872
  ends_at: {
41869
41873
  description:
41870
41874
  'Ending date and time for the access grant.',
41875
+ format: 'date-time',
41871
41876
  type: 'string',
41872
41877
  },
41873
41878
  facility_keys: {
@@ -41929,6 +41934,7 @@ export default {
41929
41934
  starts_at: {
41930
41935
  description:
41931
41936
  'Starting date and time for the access grant.',
41937
+ format: 'date-time',
41932
41938
  type: 'string',
41933
41939
  },
41934
41940
  tenant_key: {
@@ -42698,6 +42704,7 @@ export default {
42698
42704
  ends_at: {
42699
42705
  description:
42700
42706
  'Ending date and time for the access grant.',
42707
+ format: 'date-time',
42701
42708
  type: 'string',
42702
42709
  },
42703
42710
  facility_keys: {
@@ -42753,6 +42760,7 @@ export default {
42753
42760
  starts_at: {
42754
42761
  description:
42755
42762
  'Starting date and time for the access grant.',
42763
+ format: 'date-time',
42756
42764
  type: 'string',
42757
42765
  },
42758
42766
  tenant_key: {
@@ -42807,6 +42815,7 @@ export default {
42807
42815
  ends_at: {
42808
42816
  description:
42809
42817
  'Ending date and time for the access grant.',
42818
+ format: 'date-time',
42810
42819
  type: 'string',
42811
42820
  },
42812
42821
  facility_keys: {
@@ -42862,6 +42871,7 @@ export default {
42862
42871
  starts_at: {
42863
42872
  description:
42864
42873
  'Starting date and time for the access grant.',
42874
+ format: 'date-time',
42865
42875
  type: 'string',
42866
42876
  },
42867
42877
  tenant_key: {
@@ -43076,6 +43086,7 @@ export default {
43076
43086
  ends_at: {
43077
43087
  description:
43078
43088
  'Ending date and time for the access grant.',
43089
+ format: 'date-time',
43079
43090
  type: 'string',
43080
43091
  },
43081
43092
  facility_keys: {
@@ -43137,6 +43148,7 @@ export default {
43137
43148
  starts_at: {
43138
43149
  description:
43139
43150
  'Starting date and time for the access grant.',
43151
+ format: 'date-time',
43140
43152
  type: 'string',
43141
43153
  },
43142
43154
  tenant_key: {
@@ -52774,10 +52786,154 @@ export default {
52774
52786
  'x-undocumented': 'Internal endpoint for customer portals.',
52775
52787
  },
52776
52788
  },
52789
+ '/seam/customer/v1/connectors/connector_types': {
52790
+ get: {
52791
+ description:
52792
+ 'Lists all available connector types and their required instance configuration schemas.',
52793
+ operationId: 'seamCustomerV1ConnectorsConnectorTypesGet',
52794
+ responses: {
52795
+ 200: {
52796
+ content: {
52797
+ 'application/json': {
52798
+ schema: {
52799
+ properties: {
52800
+ connector_types: {
52801
+ items: {
52802
+ properties: {
52803
+ connector_type: { type: 'string' },
52804
+ description: { type: 'string' },
52805
+ display_name: { type: 'string' },
52806
+ instance_config_schema: {
52807
+ $ref: '#/components/schemas/access_code',
52808
+ },
52809
+ static_config: {
52810
+ properties: {
52811
+ base_api_url: { type: 'string' },
52812
+ polling_enabled: { type: 'boolean' },
52813
+ polling_frequency_minutes: {
52814
+ format: 'float',
52815
+ type: 'number',
52816
+ },
52817
+ },
52818
+ required: [
52819
+ 'base_api_url',
52820
+ 'polling_enabled',
52821
+ 'polling_frequency_minutes',
52822
+ ],
52823
+ type: 'object',
52824
+ },
52825
+ },
52826
+ required: [
52827
+ 'connector_type',
52828
+ 'display_name',
52829
+ 'static_config',
52830
+ ],
52831
+ type: 'object',
52832
+ },
52833
+ type: 'array',
52834
+ },
52835
+ ok: { type: 'boolean' },
52836
+ },
52837
+ required: ['connector_types', 'ok'],
52838
+ type: 'object',
52839
+ },
52840
+ },
52841
+ },
52842
+ description: 'OK',
52843
+ },
52844
+ 400: { description: 'Bad Request' },
52845
+ 401: { description: 'Unauthorized' },
52846
+ },
52847
+ security: [
52848
+ { api_key: [] },
52849
+ { client_session: [] },
52850
+ { console_session_with_workspace: [] },
52851
+ ],
52852
+ summary: '/seam/customer/v1/connectors/connector_types',
52853
+ tags: [],
52854
+ 'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'connectors'],
52855
+ 'x-fern-sdk-method-name': 'connector_types',
52856
+ 'x-fern-sdk-return-value': 'connector_types',
52857
+ 'x-response-key': 'connector_types',
52858
+ 'x-title': 'List Connector Types',
52859
+ 'x-undocumented': 'Internal endpoint for Console.',
52860
+ },
52861
+ post: {
52862
+ description:
52863
+ 'Lists all available connector types and their required instance configuration schemas.',
52864
+ operationId: 'seamCustomerV1ConnectorsConnectorTypesPost',
52865
+ responses: {
52866
+ 200: {
52867
+ content: {
52868
+ 'application/json': {
52869
+ schema: {
52870
+ properties: {
52871
+ connector_types: {
52872
+ items: {
52873
+ properties: {
52874
+ connector_type: { type: 'string' },
52875
+ description: { type: 'string' },
52876
+ display_name: { type: 'string' },
52877
+ instance_config_schema: {
52878
+ $ref: '#/components/schemas/access_code',
52879
+ },
52880
+ static_config: {
52881
+ properties: {
52882
+ base_api_url: { type: 'string' },
52883
+ polling_enabled: { type: 'boolean' },
52884
+ polling_frequency_minutes: {
52885
+ format: 'float',
52886
+ type: 'number',
52887
+ },
52888
+ },
52889
+ required: [
52890
+ 'base_api_url',
52891
+ 'polling_enabled',
52892
+ 'polling_frequency_minutes',
52893
+ ],
52894
+ type: 'object',
52895
+ },
52896
+ },
52897
+ required: [
52898
+ 'connector_type',
52899
+ 'display_name',
52900
+ 'static_config',
52901
+ ],
52902
+ type: 'object',
52903
+ },
52904
+ type: 'array',
52905
+ },
52906
+ ok: { type: 'boolean' },
52907
+ },
52908
+ required: ['connector_types', 'ok'],
52909
+ type: 'object',
52910
+ },
52911
+ },
52912
+ },
52913
+ description: 'OK',
52914
+ },
52915
+ 400: { description: 'Bad Request' },
52916
+ 401: { description: 'Unauthorized' },
52917
+ },
52918
+ security: [
52919
+ { api_key: [] },
52920
+ { client_session: [] },
52921
+ { console_session_with_workspace: [] },
52922
+ ],
52923
+ summary: '/seam/customer/v1/connectors/connector_types',
52924
+ tags: [],
52925
+ 'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'connectors'],
52926
+ 'x-fern-sdk-method-name': 'connector_types',
52927
+ 'x-fern-sdk-return-value': 'connector_types',
52928
+ 'x-response-key': 'connector_types',
52929
+ 'x-title': 'List Connector Types',
52930
+ 'x-undocumented': 'Internal endpoint for Console.',
52931
+ },
52932
+ },
52777
52933
  '/seam/customer/v1/connectors/create': {
52778
52934
  post: {
52779
52935
  description:
52780
- 'Creates a new connector for a customer in a workspace. The connector will be activated and start syncing data from the external API.\nIf a connector already exists with the same unique_provider_resource_key, it will be updated instead of creating a new one.',
52936
+ 'Creates a new connector for a customer in a workspace. The connector will be activated and start syncing data from the external API.\nIf a connector already exists for the same customer, it will be updated instead of creating a new one.',
52781
52937
  operationId: 'seamCustomerV1ConnectorsCreatePost',
52782
52938
  requestBody: {
52783
52939
  content: {
@@ -52785,32 +52941,14 @@ export default {
52785
52941
  schema: {
52786
52942
  properties: {
52787
52943
  config: {
52944
+ additionalProperties: {},
52788
52945
  description:
52789
52946
  'Instance-specific configuration for the connector',
52790
- oneOf: [
52791
- {
52792
- properties: {
52793
- access_token: { minLength: 1, type: 'string' },
52794
- client: {
52795
- default: 'seam',
52796
- minLength: 1,
52797
- type: 'string',
52798
- },
52799
- client_token: { minLength: 1, type: 'string' },
52800
- enterprise_id: { format: 'uuid', type: 'string' },
52801
- enterprise_ids: {
52802
- items: { format: 'uuid', type: 'string' },
52803
- type: 'array',
52804
- },
52805
- },
52806
- type: 'object',
52807
- },
52808
- { properties: {}, type: 'object' },
52809
- ],
52947
+ type: 'object',
52810
52948
  },
52811
52949
  connector_type: {
52812
52950
  description: 'Type of connector to create',
52813
- enum: ['mews', 'mock'],
52951
+ enum: ['mock', 'mews', 'rms'],
52814
52952
  type: 'string',
52815
52953
  },
52816
52954
  customer_key: {
@@ -53164,6 +53302,7 @@ export default {
53164
53302
  description:
53165
53303
  'Instance-specific configuration for the connector',
53166
53304
  oneOf: [
53305
+ { properties: {}, type: 'object' },
53167
53306
  {
53168
53307
  properties: {
53169
53308
  access_token: { minLength: 1, type: 'string' },
@@ -53173,15 +53312,39 @@ export default {
53173
53312
  type: 'string',
53174
53313
  },
53175
53314
  client_token: { minLength: 1, type: 'string' },
53176
- enterprise_id: { format: 'uuid', type: 'string' },
53315
+ enterprise_id: { type: 'string' },
53177
53316
  enterprise_ids: {
53178
- items: { format: 'uuid', type: 'string' },
53317
+ items: { type: 'string' },
53179
53318
  type: 'array',
53180
53319
  },
53181
53320
  },
53182
53321
  type: 'object',
53183
53322
  },
53184
- { properties: {}, type: 'object' },
53323
+ {
53324
+ properties: {
53325
+ client_id: {
53326
+ description: 'RMS client ID for authentication',
53327
+ minLength: 1,
53328
+ type: 'string',
53329
+ },
53330
+ client_password: {
53331
+ description:
53332
+ 'RMS client password for authentication',
53333
+ minLength: 1,
53334
+ type: 'string',
53335
+ },
53336
+ property_id: {
53337
+ description:
53338
+ 'Optional property ID for single-property connectors',
53339
+ oneOf: [
53340
+ { type: 'string' },
53341
+ { format: 'float', type: 'number' },
53342
+ ],
53343
+ },
53344
+ },
53345
+ required: ['client_id', 'client_password'],
53346
+ type: 'object',
53347
+ },
53185
53348
  ],
53186
53349
  },
53187
53350
  connector_id: {
@@ -68283,25 +68283,40 @@ export type Routes = {
68283
68283
  formData: {}
68284
68284
  jsonResponse: {}
68285
68285
  }
68286
+ '/seam/customer/v1/connectors/connector_types': {
68287
+ route: '/seam/customer/v1/connectors/connector_types'
68288
+ method: 'GET' | 'POST'
68289
+ queryParams: {}
68290
+ jsonBody: {}
68291
+ commonParams: {}
68292
+ formData: {}
68293
+ jsonResponse: {
68294
+ connector_types: {
68295
+ connector_type: string
68296
+ display_name: string
68297
+ description?: string | undefined
68298
+ instance_config_schema?: any
68299
+ static_config: {
68300
+ base_api_url: string
68301
+ polling_enabled: boolean
68302
+ polling_frequency_minutes: number
68303
+ }
68304
+ }[]
68305
+ }
68306
+ }
68286
68307
  '/seam/customer/v1/connectors/create': {
68287
68308
  route: '/seam/customer/v1/connectors/create'
68288
68309
  method: 'POST'
68289
68310
  queryParams: {}
68290
68311
  jsonBody: {
68291
68312
  /** Type of connector to create */
68292
- connector_type: 'mews' | 'mock'
68313
+ connector_type: 'mock' | 'mews' | 'rms'
68293
68314
  /** Key identifying the customer */
68294
68315
  customer_key?: string | undefined
68295
68316
  /** Instance-specific configuration for the connector */
68296
- config:
68297
- | {
68298
- client_token?: string | undefined
68299
- access_token?: string | undefined
68300
- client?: string
68301
- enterprise_ids?: string[] | undefined
68302
- enterprise_id?: string | undefined
68303
- }
68304
- | {}
68317
+ config: {
68318
+ [x: string]: unknown
68319
+ }
68305
68320
  }
68306
68321
  commonParams: {}
68307
68322
  formData: {}
@@ -68389,6 +68404,7 @@ export type Routes = {
68389
68404
  customer_key?: string | undefined
68390
68405
  /** Instance-specific configuration for the connector */
68391
68406
  config:
68407
+ | {}
68392
68408
  | {
68393
68409
  client_token?: string | undefined
68394
68410
  access_token?: string | undefined
@@ -68396,7 +68412,14 @@ export type Routes = {
68396
68412
  enterprise_ids?: string[] | undefined
68397
68413
  enterprise_id?: string | undefined
68398
68414
  }
68399
- | {}
68415
+ | {
68416
+ /** RMS client ID for authentication */
68417
+ client_id: string
68418
+ /** RMS client password for authentication */
68419
+ client_password: string
68420
+ /** Optional property ID for single-property connectors */
68421
+ property_id?: (string | number) | undefined
68422
+ }
68400
68423
  }
68401
68424
  commonParams: {}
68402
68425
  formData: {}