@seamapi/types 1.650.0 → 1.652.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.
@@ -84713,9 +84713,15 @@ declare const _default: {
84713
84713
  };
84714
84714
  };
84715
84715
  is_embedded: boolean;
84716
+ locale: string;
84716
84717
  };
84717
84718
  description: string;
84718
84719
  properties: {
84720
+ customization_profile_id: {
84721
+ description: string;
84722
+ format: string;
84723
+ type: string;
84724
+ };
84719
84725
  features: {
84720
84726
  default: {};
84721
84727
  properties: {
@@ -84733,11 +84739,6 @@ declare const _default: {
84733
84739
  description: string;
84734
84740
  type: string;
84735
84741
  };
84736
- customization_profile_id: {
84737
- description: string;
84738
- format: string;
84739
- type: string;
84740
- };
84741
84742
  exclude: {
84742
84743
  default: boolean;
84743
84744
  description: string;
@@ -85039,6 +85040,12 @@ declare const _default: {
85039
85040
  };
85040
85041
  type: string;
85041
85042
  };
85043
+ locale: {
85044
+ default: string;
85045
+ description: string;
85046
+ enum: string[];
85047
+ type: string;
85048
+ };
85042
85049
  customer_data?: never;
85043
85050
  };
85044
85051
  type: string;
@@ -85820,9 +85827,11 @@ declare const _default: {
85820
85827
  required: string[];
85821
85828
  type: string;
85822
85829
  };
85830
+ customization_profile_id?: never;
85823
85831
  features?: never;
85824
85832
  is_embedded?: never;
85825
85833
  landing_page?: never;
85834
+ locale?: never;
85826
85835
  };
85827
85836
  type: string;
85828
85837
  default?: never;
@@ -96164,23 +96173,29 @@ declare const _default: {
96164
96173
  display_name: {
96165
96174
  type: string;
96166
96175
  };
96167
- instance_config_schema: {
96168
- $ref: string;
96169
- };
96170
- static_config: {
96171
- properties: {
96172
- base_api_url: {
96173
- type: string;
96174
- };
96175
- polling_enabled: {
96176
- type: string;
96177
- };
96178
- polling_frequency_minutes: {
96179
- format: string;
96180
- type: string;
96176
+ editable_fields: {
96177
+ items: {
96178
+ properties: {
96179
+ description: {
96180
+ type: string;
96181
+ };
96182
+ display_name: {
96183
+ type: string;
96184
+ };
96185
+ name: {
96186
+ type: string;
96187
+ };
96188
+ required: {
96189
+ type: string;
96190
+ };
96191
+ type: {
96192
+ enum: string[];
96193
+ type: string;
96194
+ };
96181
96195
  };
96196
+ required: string[];
96197
+ type: string;
96182
96198
  };
96183
- required: string[];
96184
96199
  type: string;
96185
96200
  };
96186
96201
  };
@@ -96250,23 +96265,29 @@ declare const _default: {
96250
96265
  display_name: {
96251
96266
  type: string;
96252
96267
  };
96253
- instance_config_schema: {
96254
- $ref: string;
96255
- };
96256
- static_config: {
96257
- properties: {
96258
- base_api_url: {
96259
- type: string;
96260
- };
96261
- polling_enabled: {
96262
- type: string;
96263
- };
96264
- polling_frequency_minutes: {
96265
- format: string;
96266
- type: string;
96268
+ editable_fields: {
96269
+ items: {
96270
+ properties: {
96271
+ description: {
96272
+ type: string;
96273
+ };
96274
+ display_name: {
96275
+ type: string;
96276
+ };
96277
+ name: {
96278
+ type: string;
96279
+ };
96280
+ required: {
96281
+ type: string;
96282
+ };
96283
+ type: {
96284
+ enum: string[];
96285
+ type: string;
96286
+ };
96267
96287
  };
96288
+ required: string[];
96289
+ type: string;
96268
96290
  };
96269
- required: string[];
96270
96291
  type: string;
96271
96292
  };
96272
96293
  };
@@ -96776,6 +96797,7 @@ declare const _default: {
96776
96797
  client_token?: never;
96777
96798
  enterprise_id?: never;
96778
96799
  enterprise_ids?: never;
96800
+ auth_token?: never;
96779
96801
  client_id?: never;
96780
96802
  client_password?: never;
96781
96803
  property_id?: never;
@@ -96806,6 +96828,7 @@ declare const _default: {
96806
96828
  };
96807
96829
  type: string;
96808
96830
  };
96831
+ auth_token?: never;
96809
96832
  client_id?: never;
96810
96833
  client_password?: never;
96811
96834
  property_id?: never;
@@ -96814,6 +96837,9 @@ declare const _default: {
96814
96837
  required?: never;
96815
96838
  } | {
96816
96839
  properties: {
96840
+ auth_token: {
96841
+ type: string;
96842
+ };
96817
96843
  client_id: {
96818
96844
  description: string;
96819
96845
  minLength: number;
@@ -97222,6 +97248,11 @@ declare const _default: {
97222
97248
  enum: string[];
97223
97249
  type: string;
97224
97250
  };
97251
+ customization_profile_id: {
97252
+ description: string;
97253
+ format: string;
97254
+ type: string;
97255
+ };
97225
97256
  features: {
97226
97257
  default: {
97227
97258
  $ref: string;
@@ -97243,11 +97274,6 @@ declare const _default: {
97243
97274
  description: string;
97244
97275
  type: string;
97245
97276
  };
97246
- customization_profile_id: {
97247
- description: string;
97248
- format: string;
97249
- type: string;
97250
- };
97251
97277
  exclude: {
97252
97278
  default: boolean;
97253
97279
  description: string;
@@ -97557,6 +97583,12 @@ declare const _default: {
97557
97583
  };
97558
97584
  type: string;
97559
97585
  };
97586
+ locale: {
97587
+ default: string;
97588
+ description: string;
97589
+ enum: string[];
97590
+ type: string;
97591
+ };
97560
97592
  };
97561
97593
  type: string;
97562
97594
  };
@@ -97623,6 +97655,11 @@ declare const _default: {
97623
97655
  enum: string[];
97624
97656
  type: string;
97625
97657
  };
97658
+ customization_profile_id: {
97659
+ description: string;
97660
+ format: string;
97661
+ type: string;
97662
+ };
97626
97663
  features: {
97627
97664
  default: {
97628
97665
  $ref: string;
@@ -97644,11 +97681,6 @@ declare const _default: {
97644
97681
  description: string;
97645
97682
  type: string;
97646
97683
  };
97647
- customization_profile_id: {
97648
- description: string;
97649
- format: string;
97650
- type: string;
97651
- };
97652
97684
  exclude: {
97653
97685
  default: boolean;
97654
97686
  description: string;
@@ -97958,6 +97990,12 @@ declare const _default: {
97958
97990
  };
97959
97991
  type: string;
97960
97992
  };
97993
+ locale: {
97994
+ default: string;
97995
+ description: string;
97996
+ enum: string[];
97997
+ type: string;
97998
+ };
97961
97999
  };
97962
98000
  type: string;
97963
98001
  };
@@ -138451,8 +138489,6 @@ type Routes = {
138451
138489
  configure?: {
138452
138490
  /** Whether to exclude this feature from the portal. */
138453
138491
  exclude?: boolean;
138454
- /** The ID of the customization profile to use for the portal. */
138455
- customization_profile_id?: string | undefined;
138456
138492
  /** Indicates whether the customer can customize the access automation rules for their properties. */
138457
138493
  allow_access_automation_rule_customization?: boolean;
138458
138494
  /** Indicates whether the customer can customize the Instant Key profile for their properties. */
@@ -138491,6 +138527,10 @@ type Routes = {
138491
138527
  access_grant_key: string;
138492
138528
  })) | undefined;
138493
138529
  } | undefined;
138530
+ /** The locale to use for the portal. */
138531
+ locale?: 'en-US' | 'pt-PT' | 'auto';
138532
+ /** The ID of the customization profile to use for the portal. */
138533
+ customization_profile_id?: string | undefined;
138494
138534
  } & {
138495
138535
  customer_data?: {
138496
138536
  /** Your unique identifier for the customer. */
@@ -164050,12 +164090,13 @@ type Routes = {
164050
164090
  connector_type: string;
164051
164091
  display_name: string;
164052
164092
  description?: string | undefined;
164053
- instance_config_schema?: any;
164054
- static_config: {
164055
- base_api_url: string;
164056
- polling_enabled: boolean;
164057
- polling_frequency_minutes: number;
164058
- };
164093
+ editable_fields: {
164094
+ name: string;
164095
+ display_name: string;
164096
+ description: string;
164097
+ type: 'string' | 'string[]' | 'number' | 'boolean';
164098
+ required: boolean;
164099
+ }[];
164059
164100
  }[];
164060
164101
  };
164061
164102
  };
@@ -164169,6 +164210,7 @@ type Routes = {
164169
164210
  client_password: string;
164170
164211
  /** Optional property ID for single-property connectors */
164171
164212
  property_id?: (string | number) | undefined;
164213
+ auth_token?: string | undefined;
164172
164214
  };
164173
164215
  };
164174
164216
  commonParams: {};
@@ -166174,8 +166216,6 @@ type Routes = {
166174
166216
  configure?: {
166175
166217
  /** Whether to exclude this feature from the portal. */
166176
166218
  exclude?: boolean;
166177
- /** The ID of the customization profile to use for the portal. */
166178
- customization_profile_id?: string | undefined;
166179
166219
  /** Indicates whether the customer can customize the access automation rules for their properties. */
166180
166220
  allow_access_automation_rule_customization?: boolean;
166181
166221
  /** Indicates whether the customer can customize the Instant Key profile for their properties. */
@@ -166214,6 +166254,10 @@ type Routes = {
166214
166254
  access_grant_key: string;
166215
166255
  })) | undefined;
166216
166256
  } | undefined;
166257
+ /** The locale to use for the portal. */
166258
+ locale?: 'en-US' | 'pt-PT' | 'auto';
166259
+ /** The ID of the customization profile to use for the portal. */
166260
+ customization_profile_id?: string | undefined;
166217
166261
  /** Business vertical of the customer portal. */
166218
166262
  business_vertical?: ('short_term_rental' | 'hospitality' | 'multi_family' | 'gym_management' | 'property_tours') | undefined;
166219
166263
  };
package/dist/index.cjs CHANGED
@@ -43278,10 +43278,16 @@ var openapi_default = {
43278
43278
  manage_devices: { exclude: false },
43279
43279
  organize: { exclude: false }
43280
43280
  },
43281
- is_embedded: false
43281
+ is_embedded: false,
43282
+ locale: "auto"
43282
43283
  },
43283
43284
  description: "Configuration for a customer portal",
43284
43285
  properties: {
43286
+ customization_profile_id: {
43287
+ description: "The ID of the customization profile to use for the portal.",
43288
+ format: "uuid",
43289
+ type: "string"
43290
+ },
43285
43291
  features: {
43286
43292
  default: {},
43287
43293
  properties: {
@@ -43299,11 +43305,6 @@ var openapi_default = {
43299
43305
  description: "Indicates whether the customer can customize the Instant Key profile for their properties.",
43300
43306
  type: "boolean"
43301
43307
  },
43302
- customization_profile_id: {
43303
- description: "The ID of the customization profile to use for the portal.",
43304
- format: "uuid",
43305
- type: "string"
43306
- },
43307
43308
  exclude: {
43308
43309
  default: false,
43309
43310
  description: "Whether to exclude this feature from the portal.",
@@ -43496,6 +43497,12 @@ var openapi_default = {
43496
43497
  }
43497
43498
  },
43498
43499
  type: "object"
43500
+ },
43501
+ locale: {
43502
+ default: "auto",
43503
+ description: "The locale to use for the portal.",
43504
+ enum: ["en-US", "pt-PT", "auto"],
43505
+ type: "string"
43499
43506
  }
43500
43507
  },
43501
43508
  type: "object"
@@ -54279,7 +54286,7 @@ var openapi_default = {
54279
54286
  },
54280
54287
  "/seam/customer/v1/connectors/connector_types": {
54281
54288
  get: {
54282
- description: "Lists all available connector types and their required instance configuration schemas.",
54289
+ description: "Lists all available connector types and their editable fields for UI input.",
54283
54290
  operationId: "seamCustomerV1ConnectorsConnectorTypesGet",
54284
54291
  responses: {
54285
54292
  200: {
@@ -54293,30 +54300,39 @@ var openapi_default = {
54293
54300
  connector_type: { type: "string" },
54294
54301
  description: { type: "string" },
54295
54302
  display_name: { type: "string" },
54296
- instance_config_schema: {
54297
- $ref: "#/components/schemas/access_code"
54298
- },
54299
- static_config: {
54300
- properties: {
54301
- base_api_url: { type: "string" },
54302
- polling_enabled: { type: "boolean" },
54303
- polling_frequency_minutes: {
54304
- format: "float",
54305
- type: "number"
54306
- }
54303
+ editable_fields: {
54304
+ items: {
54305
+ properties: {
54306
+ description: { type: "string" },
54307
+ display_name: { type: "string" },
54308
+ name: { type: "string" },
54309
+ required: { type: "boolean" },
54310
+ type: {
54311
+ enum: [
54312
+ "string",
54313
+ "string[]",
54314
+ "number",
54315
+ "boolean"
54316
+ ],
54317
+ type: "string"
54318
+ }
54319
+ },
54320
+ required: [
54321
+ "name",
54322
+ "display_name",
54323
+ "description",
54324
+ "type",
54325
+ "required"
54326
+ ],
54327
+ type: "object"
54307
54328
  },
54308
- required: [
54309
- "base_api_url",
54310
- "polling_enabled",
54311
- "polling_frequency_minutes"
54312
- ],
54313
- type: "object"
54329
+ type: "array"
54314
54330
  }
54315
54331
  },
54316
54332
  required: [
54317
54333
  "connector_type",
54318
54334
  "display_name",
54319
- "static_config"
54335
+ "editable_fields"
54320
54336
  ],
54321
54337
  type: "object"
54322
54338
  },
@@ -54349,7 +54365,7 @@ var openapi_default = {
54349
54365
  "x-undocumented": "Internal endpoint for Console."
54350
54366
  },
54351
54367
  post: {
54352
- description: "Lists all available connector types and their required instance configuration schemas.",
54368
+ description: "Lists all available connector types and their editable fields for UI input.",
54353
54369
  operationId: "seamCustomerV1ConnectorsConnectorTypesPost",
54354
54370
  responses: {
54355
54371
  200: {
@@ -54363,30 +54379,39 @@ var openapi_default = {
54363
54379
  connector_type: { type: "string" },
54364
54380
  description: { type: "string" },
54365
54381
  display_name: { type: "string" },
54366
- instance_config_schema: {
54367
- $ref: "#/components/schemas/access_code"
54368
- },
54369
- static_config: {
54370
- properties: {
54371
- base_api_url: { type: "string" },
54372
- polling_enabled: { type: "boolean" },
54373
- polling_frequency_minutes: {
54374
- format: "float",
54375
- type: "number"
54376
- }
54382
+ editable_fields: {
54383
+ items: {
54384
+ properties: {
54385
+ description: { type: "string" },
54386
+ display_name: { type: "string" },
54387
+ name: { type: "string" },
54388
+ required: { type: "boolean" },
54389
+ type: {
54390
+ enum: [
54391
+ "string",
54392
+ "string[]",
54393
+ "number",
54394
+ "boolean"
54395
+ ],
54396
+ type: "string"
54397
+ }
54398
+ },
54399
+ required: [
54400
+ "name",
54401
+ "display_name",
54402
+ "description",
54403
+ "type",
54404
+ "required"
54405
+ ],
54406
+ type: "object"
54377
54407
  },
54378
- required: [
54379
- "base_api_url",
54380
- "polling_enabled",
54381
- "polling_frequency_minutes"
54382
- ],
54383
- type: "object"
54408
+ type: "array"
54384
54409
  }
54385
54410
  },
54386
54411
  required: [
54387
54412
  "connector_type",
54388
54413
  "display_name",
54389
- "static_config"
54414
+ "editable_fields"
54390
54415
  ],
54391
54416
  type: "object"
54392
54417
  },
@@ -54803,6 +54828,7 @@ var openapi_default = {
54803
54828
  },
54804
54829
  {
54805
54830
  properties: {
54831
+ auth_token: { type: "string" },
54806
54832
  client_id: {
54807
54833
  description: "RMS client ID for authentication",
54808
54834
  minLength: 1,
@@ -55517,6 +55543,11 @@ var openapi_default = {
55517
55543
  ],
55518
55544
  type: "string"
55519
55545
  },
55546
+ customization_profile_id: {
55547
+ description: "The ID of the customization profile to use for the portal.",
55548
+ format: "uuid",
55549
+ type: "string"
55550
+ },
55520
55551
  features: {
55521
55552
  default: { $ref: "#/components/schemas/access_code" },
55522
55553
  properties: {
@@ -55536,11 +55567,6 @@ var openapi_default = {
55536
55567
  description: "Indicates whether the customer can customize the Instant Key profile for their properties.",
55537
55568
  type: "boolean"
55538
55569
  },
55539
- customization_profile_id: {
55540
- description: "The ID of the customization profile to use for the portal.",
55541
- format: "uuid",
55542
- type: "string"
55543
- },
55544
55570
  exclude: {
55545
55571
  default: false,
55546
55572
  description: "Whether to exclude this feature from the portal.",
@@ -55743,6 +55769,12 @@ var openapi_default = {
55743
55769
  }
55744
55770
  },
55745
55771
  type: "object"
55772
+ },
55773
+ locale: {
55774
+ default: "auto",
55775
+ description: "The locale to use for the portal.",
55776
+ enum: ["en-US", "pt-PT", "auto"],
55777
+ type: "string"
55746
55778
  }
55747
55779
  },
55748
55780
  type: "object"
@@ -55808,6 +55840,11 @@ var openapi_default = {
55808
55840
  ],
55809
55841
  type: "string"
55810
55842
  },
55843
+ customization_profile_id: {
55844
+ description: "The ID of the customization profile to use for the portal.",
55845
+ format: "uuid",
55846
+ type: "string"
55847
+ },
55811
55848
  features: {
55812
55849
  default: { $ref: "#/components/schemas/access_code" },
55813
55850
  properties: {
@@ -55827,11 +55864,6 @@ var openapi_default = {
55827
55864
  description: "Indicates whether the customer can customize the Instant Key profile for their properties.",
55828
55865
  type: "boolean"
55829
55866
  },
55830
- customization_profile_id: {
55831
- description: "The ID of the customization profile to use for the portal.",
55832
- format: "uuid",
55833
- type: "string"
55834
- },
55835
55867
  exclude: {
55836
55868
  default: false,
55837
55869
  description: "Whether to exclude this feature from the portal.",
@@ -56034,6 +56066,12 @@ var openapi_default = {
56034
56066
  }
56035
56067
  },
56036
56068
  type: "object"
56069
+ },
56070
+ locale: {
56071
+ default: "auto",
56072
+ description: "The locale to use for the portal.",
56073
+ enum: ["en-US", "pt-PT", "auto"],
56074
+ type: "string"
56037
56075
  }
56038
56076
  },
56039
56077
  type: "object"