@seamapi/types 1.642.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.
- package/dist/connect.cjs +172 -25
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +247 -49
- package/dist/index.cjs +172 -25
- package/dist/index.cjs.map +1 -1
- package/lib/seam/connect/openapi.d.ts +214 -40
- package/lib/seam/connect/openapi.js +172 -25
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +33 -9
- package/package.json +1 -1
- package/src/lib/seam/connect/openapi.ts +176 -25
- package/src/lib/seam/connect/route-types.ts +34 -11
|
@@ -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' | '
|
|
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
|
-
|
|
57471
|
-
|
|
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
|
@@ -52786,10 +52786,154 @@ export default {
|
|
|
52786
52786
|
'x-undocumented': 'Internal endpoint for customer portals.',
|
|
52787
52787
|
},
|
|
52788
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
|
+
},
|
|
52789
52933
|
'/seam/customer/v1/connectors/create': {
|
|
52790
52934
|
post: {
|
|
52791
52935
|
description:
|
|
52792
|
-
'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
|
|
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.',
|
|
52793
52937
|
operationId: 'seamCustomerV1ConnectorsCreatePost',
|
|
52794
52938
|
requestBody: {
|
|
52795
52939
|
content: {
|
|
@@ -52797,32 +52941,14 @@ export default {
|
|
|
52797
52941
|
schema: {
|
|
52798
52942
|
properties: {
|
|
52799
52943
|
config: {
|
|
52944
|
+
additionalProperties: {},
|
|
52800
52945
|
description:
|
|
52801
52946
|
'Instance-specific configuration for the connector',
|
|
52802
|
-
|
|
52803
|
-
{
|
|
52804
|
-
properties: {
|
|
52805
|
-
access_token: { minLength: 1, type: 'string' },
|
|
52806
|
-
client: {
|
|
52807
|
-
default: 'seam',
|
|
52808
|
-
minLength: 1,
|
|
52809
|
-
type: 'string',
|
|
52810
|
-
},
|
|
52811
|
-
client_token: { minLength: 1, type: 'string' },
|
|
52812
|
-
enterprise_id: { format: 'uuid', type: 'string' },
|
|
52813
|
-
enterprise_ids: {
|
|
52814
|
-
items: { format: 'uuid', type: 'string' },
|
|
52815
|
-
type: 'array',
|
|
52816
|
-
},
|
|
52817
|
-
},
|
|
52818
|
-
type: 'object',
|
|
52819
|
-
},
|
|
52820
|
-
{ properties: {}, type: 'object' },
|
|
52821
|
-
],
|
|
52947
|
+
type: 'object',
|
|
52822
52948
|
},
|
|
52823
52949
|
connector_type: {
|
|
52824
52950
|
description: 'Type of connector to create',
|
|
52825
|
-
enum: ['mews', '
|
|
52951
|
+
enum: ['mock', 'mews', 'rms'],
|
|
52826
52952
|
type: 'string',
|
|
52827
52953
|
},
|
|
52828
52954
|
customer_key: {
|
|
@@ -53176,6 +53302,7 @@ export default {
|
|
|
53176
53302
|
description:
|
|
53177
53303
|
'Instance-specific configuration for the connector',
|
|
53178
53304
|
oneOf: [
|
|
53305
|
+
{ properties: {}, type: 'object' },
|
|
53179
53306
|
{
|
|
53180
53307
|
properties: {
|
|
53181
53308
|
access_token: { minLength: 1, type: 'string' },
|
|
@@ -53185,15 +53312,39 @@ export default {
|
|
|
53185
53312
|
type: 'string',
|
|
53186
53313
|
},
|
|
53187
53314
|
client_token: { minLength: 1, type: 'string' },
|
|
53188
|
-
enterprise_id: {
|
|
53315
|
+
enterprise_id: { type: 'string' },
|
|
53189
53316
|
enterprise_ids: {
|
|
53190
|
-
items: {
|
|
53317
|
+
items: { type: 'string' },
|
|
53191
53318
|
type: 'array',
|
|
53192
53319
|
},
|
|
53193
53320
|
},
|
|
53194
53321
|
type: 'object',
|
|
53195
53322
|
},
|
|
53196
|
-
{
|
|
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
|
+
},
|
|
53197
53348
|
],
|
|
53198
53349
|
},
|
|
53199
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' | '
|
|
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
|
-
|
|
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: {}
|