@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.
- package/dist/connect.cjs +92 -54
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +99 -55
- package/dist/index.cjs +92 -54
- package/dist/index.cjs.map +1 -1
- package/lib/seam/connect/models/customer/customer-portal.d.ts +12 -14
- package/lib/seam/connect/models/customer/customer-portal.js +11 -5
- package/lib/seam/connect/models/customer/customer-portal.js.map +1 -1
- package/lib/seam/connect/openapi.d.ts +83 -45
- package/lib/seam/connect/openapi.js +89 -51
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +16 -10
- package/package.json +1 -1
- package/src/lib/seam/connect/models/customer/customer-portal.ts +11 -5
- package/src/lib/seam/connect/openapi.ts +92 -54
- package/src/lib/seam/connect/route-types.ts +16 -10
|
@@ -26352,8 +26352,6 @@ export type Routes = {
|
|
|
26352
26352
|
configure?: {
|
|
26353
26353
|
/** Whether to exclude this feature from the portal. */
|
|
26354
26354
|
exclude?: boolean;
|
|
26355
|
-
/** The ID of the customization profile to use for the portal. */
|
|
26356
|
-
customization_profile_id?: string | undefined;
|
|
26357
26355
|
/** Indicates whether the customer can customize the access automation rules for their properties. */
|
|
26358
26356
|
allow_access_automation_rule_customization?: boolean;
|
|
26359
26357
|
/** Indicates whether the customer can customize the Instant Key profile for their properties. */
|
|
@@ -26392,6 +26390,10 @@ export type Routes = {
|
|
|
26392
26390
|
access_grant_key: string;
|
|
26393
26391
|
})) | undefined;
|
|
26394
26392
|
} | undefined;
|
|
26393
|
+
/** The locale to use for the portal. */
|
|
26394
|
+
locale?: 'en-US' | 'pt-PT' | 'auto';
|
|
26395
|
+
/** The ID of the customization profile to use for the portal. */
|
|
26396
|
+
customization_profile_id?: string | undefined;
|
|
26395
26397
|
} & {
|
|
26396
26398
|
customer_data?: {
|
|
26397
26399
|
/** Your unique identifier for the customer. */
|
|
@@ -51951,12 +51953,13 @@ export type Routes = {
|
|
|
51951
51953
|
connector_type: string;
|
|
51952
51954
|
display_name: string;
|
|
51953
51955
|
description?: string | undefined;
|
|
51954
|
-
|
|
51955
|
-
|
|
51956
|
-
|
|
51957
|
-
|
|
51958
|
-
|
|
51959
|
-
|
|
51956
|
+
editable_fields: {
|
|
51957
|
+
name: string;
|
|
51958
|
+
display_name: string;
|
|
51959
|
+
description: string;
|
|
51960
|
+
type: 'string' | 'string[]' | 'number' | 'boolean';
|
|
51961
|
+
required: boolean;
|
|
51962
|
+
}[];
|
|
51960
51963
|
}[];
|
|
51961
51964
|
};
|
|
51962
51965
|
};
|
|
@@ -52070,6 +52073,7 @@ export type Routes = {
|
|
|
52070
52073
|
client_password: string;
|
|
52071
52074
|
/** Optional property ID for single-property connectors */
|
|
52072
52075
|
property_id?: (string | number) | undefined;
|
|
52076
|
+
auth_token?: string | undefined;
|
|
52073
52077
|
};
|
|
52074
52078
|
};
|
|
52075
52079
|
commonParams: {};
|
|
@@ -54075,8 +54079,6 @@ export type Routes = {
|
|
|
54075
54079
|
configure?: {
|
|
54076
54080
|
/** Whether to exclude this feature from the portal. */
|
|
54077
54081
|
exclude?: boolean;
|
|
54078
|
-
/** The ID of the customization profile to use for the portal. */
|
|
54079
|
-
customization_profile_id?: string | undefined;
|
|
54080
54082
|
/** Indicates whether the customer can customize the access automation rules for their properties. */
|
|
54081
54083
|
allow_access_automation_rule_customization?: boolean;
|
|
54082
54084
|
/** Indicates whether the customer can customize the Instant Key profile for their properties. */
|
|
@@ -54115,6 +54117,10 @@ export type Routes = {
|
|
|
54115
54117
|
access_grant_key: string;
|
|
54116
54118
|
})) | undefined;
|
|
54117
54119
|
} | undefined;
|
|
54120
|
+
/** The locale to use for the portal. */
|
|
54121
|
+
locale?: 'en-US' | 'pt-PT' | 'auto';
|
|
54122
|
+
/** The ID of the customization profile to use for the portal. */
|
|
54123
|
+
customization_profile_id?: string | undefined;
|
|
54118
54124
|
/** Business vertical of the customer portal. */
|
|
54119
54125
|
business_vertical?: ('short_term_rental' | 'hospitality' | 'multi_family' | 'gym_management' | 'property_tours') | undefined;
|
|
54120
54126
|
};
|
package/package.json
CHANGED
|
@@ -44,11 +44,6 @@ const base_manage_feature = base_feature.extend({
|
|
|
44
44
|
const base_organize_feature = base_feature
|
|
45
45
|
|
|
46
46
|
const base_configure_feature = base_feature.extend({
|
|
47
|
-
customization_profile_id: z
|
|
48
|
-
.string()
|
|
49
|
-
.uuid()
|
|
50
|
-
.optional()
|
|
51
|
-
.describe('The ID of the customization profile to use for the portal.'),
|
|
52
47
|
allow_access_automation_rule_customization: z
|
|
53
48
|
.boolean()
|
|
54
49
|
.default(false)
|
|
@@ -98,6 +93,16 @@ export const portal_configuration_base = z.object({
|
|
|
98
93
|
})
|
|
99
94
|
.optional()
|
|
100
95
|
.describe('Configuration for the landing page when the portal loads.'),
|
|
96
|
+
locale: z
|
|
97
|
+
.enum(['en-US', 'pt-PT', 'auto'])
|
|
98
|
+
.optional()
|
|
99
|
+
.default('auto')
|
|
100
|
+
.describe('The locale to use for the portal.'),
|
|
101
|
+
customization_profile_id: z
|
|
102
|
+
.string()
|
|
103
|
+
.uuid()
|
|
104
|
+
.optional()
|
|
105
|
+
.describe('The ID of the customization profile to use for the portal.'),
|
|
101
106
|
})
|
|
102
107
|
|
|
103
108
|
export const portal_configuration = portal_configuration_base
|
|
@@ -120,6 +125,7 @@ export const portal_configuration = portal_configuration_base
|
|
|
120
125
|
},
|
|
121
126
|
},
|
|
122
127
|
is_embedded: false,
|
|
128
|
+
locale: 'auto',
|
|
123
129
|
})
|
|
124
130
|
.describe(`Configuration for a customer portal`)
|
|
125
131
|
|
|
@@ -41075,9 +41075,16 @@ export default {
|
|
|
41075
41075
|
organize: { exclude: false },
|
|
41076
41076
|
},
|
|
41077
41077
|
is_embedded: false,
|
|
41078
|
+
locale: 'auto',
|
|
41078
41079
|
},
|
|
41079
41080
|
description: 'Configuration for a customer portal',
|
|
41080
41081
|
properties: {
|
|
41082
|
+
customization_profile_id: {
|
|
41083
|
+
description:
|
|
41084
|
+
'The ID of the customization profile to use for the portal.',
|
|
41085
|
+
format: 'uuid',
|
|
41086
|
+
type: 'string',
|
|
41087
|
+
},
|
|
41081
41088
|
features: {
|
|
41082
41089
|
default: {},
|
|
41083
41090
|
properties: {
|
|
@@ -41098,12 +41105,6 @@ export default {
|
|
|
41098
41105
|
'Indicates whether the customer can customize the Instant Key profile for their properties.',
|
|
41099
41106
|
type: 'boolean',
|
|
41100
41107
|
},
|
|
41101
|
-
customization_profile_id: {
|
|
41102
|
-
description:
|
|
41103
|
-
'The ID of the customization profile to use for the portal.',
|
|
41104
|
-
format: 'uuid',
|
|
41105
|
-
type: 'string',
|
|
41106
|
-
},
|
|
41107
41108
|
exclude: {
|
|
41108
41109
|
default: false,
|
|
41109
41110
|
description:
|
|
@@ -41312,6 +41313,12 @@ export default {
|
|
|
41312
41313
|
},
|
|
41313
41314
|
type: 'object',
|
|
41314
41315
|
},
|
|
41316
|
+
locale: {
|
|
41317
|
+
default: 'auto',
|
|
41318
|
+
description: 'The locale to use for the portal.',
|
|
41319
|
+
enum: ['en-US', 'pt-PT', 'auto'],
|
|
41320
|
+
type: 'string',
|
|
41321
|
+
},
|
|
41315
41322
|
},
|
|
41316
41323
|
type: 'object',
|
|
41317
41324
|
},
|
|
@@ -52649,7 +52656,7 @@ export default {
|
|
|
52649
52656
|
'/seam/customer/v1/connectors/connector_types': {
|
|
52650
52657
|
get: {
|
|
52651
52658
|
description:
|
|
52652
|
-
'Lists all available connector types and their
|
|
52659
|
+
'Lists all available connector types and their editable fields for UI input.',
|
|
52653
52660
|
operationId: 'seamCustomerV1ConnectorsConnectorTypesGet',
|
|
52654
52661
|
responses: {
|
|
52655
52662
|
200: {
|
|
@@ -52663,30 +52670,39 @@ export default {
|
|
|
52663
52670
|
connector_type: { type: 'string' },
|
|
52664
52671
|
description: { type: 'string' },
|
|
52665
52672
|
display_name: { type: 'string' },
|
|
52666
|
-
|
|
52667
|
-
|
|
52668
|
-
|
|
52669
|
-
|
|
52670
|
-
|
|
52671
|
-
|
|
52672
|
-
|
|
52673
|
-
|
|
52674
|
-
|
|
52675
|
-
|
|
52673
|
+
editable_fields: {
|
|
52674
|
+
items: {
|
|
52675
|
+
properties: {
|
|
52676
|
+
description: { type: 'string' },
|
|
52677
|
+
display_name: { type: 'string' },
|
|
52678
|
+
name: { type: 'string' },
|
|
52679
|
+
required: { type: 'boolean' },
|
|
52680
|
+
type: {
|
|
52681
|
+
enum: [
|
|
52682
|
+
'string',
|
|
52683
|
+
'string[]',
|
|
52684
|
+
'number',
|
|
52685
|
+
'boolean',
|
|
52686
|
+
],
|
|
52687
|
+
type: 'string',
|
|
52688
|
+
},
|
|
52676
52689
|
},
|
|
52690
|
+
required: [
|
|
52691
|
+
'name',
|
|
52692
|
+
'display_name',
|
|
52693
|
+
'description',
|
|
52694
|
+
'type',
|
|
52695
|
+
'required',
|
|
52696
|
+
],
|
|
52697
|
+
type: 'object',
|
|
52677
52698
|
},
|
|
52678
|
-
|
|
52679
|
-
'base_api_url',
|
|
52680
|
-
'polling_enabled',
|
|
52681
|
-
'polling_frequency_minutes',
|
|
52682
|
-
],
|
|
52683
|
-
type: 'object',
|
|
52699
|
+
type: 'array',
|
|
52684
52700
|
},
|
|
52685
52701
|
},
|
|
52686
52702
|
required: [
|
|
52687
52703
|
'connector_type',
|
|
52688
52704
|
'display_name',
|
|
52689
|
-
'
|
|
52705
|
+
'editable_fields',
|
|
52690
52706
|
],
|
|
52691
52707
|
type: 'object',
|
|
52692
52708
|
},
|
|
@@ -52720,7 +52736,7 @@ export default {
|
|
|
52720
52736
|
},
|
|
52721
52737
|
post: {
|
|
52722
52738
|
description:
|
|
52723
|
-
'Lists all available connector types and their
|
|
52739
|
+
'Lists all available connector types and their editable fields for UI input.',
|
|
52724
52740
|
operationId: 'seamCustomerV1ConnectorsConnectorTypesPost',
|
|
52725
52741
|
responses: {
|
|
52726
52742
|
200: {
|
|
@@ -52734,30 +52750,39 @@ export default {
|
|
|
52734
52750
|
connector_type: { type: 'string' },
|
|
52735
52751
|
description: { type: 'string' },
|
|
52736
52752
|
display_name: { type: 'string' },
|
|
52737
|
-
|
|
52738
|
-
|
|
52739
|
-
|
|
52740
|
-
|
|
52741
|
-
|
|
52742
|
-
|
|
52743
|
-
|
|
52744
|
-
|
|
52745
|
-
|
|
52746
|
-
|
|
52753
|
+
editable_fields: {
|
|
52754
|
+
items: {
|
|
52755
|
+
properties: {
|
|
52756
|
+
description: { type: 'string' },
|
|
52757
|
+
display_name: { type: 'string' },
|
|
52758
|
+
name: { type: 'string' },
|
|
52759
|
+
required: { type: 'boolean' },
|
|
52760
|
+
type: {
|
|
52761
|
+
enum: [
|
|
52762
|
+
'string',
|
|
52763
|
+
'string[]',
|
|
52764
|
+
'number',
|
|
52765
|
+
'boolean',
|
|
52766
|
+
],
|
|
52767
|
+
type: 'string',
|
|
52768
|
+
},
|
|
52747
52769
|
},
|
|
52770
|
+
required: [
|
|
52771
|
+
'name',
|
|
52772
|
+
'display_name',
|
|
52773
|
+
'description',
|
|
52774
|
+
'type',
|
|
52775
|
+
'required',
|
|
52776
|
+
],
|
|
52777
|
+
type: 'object',
|
|
52748
52778
|
},
|
|
52749
|
-
|
|
52750
|
-
'base_api_url',
|
|
52751
|
-
'polling_enabled',
|
|
52752
|
-
'polling_frequency_minutes',
|
|
52753
|
-
],
|
|
52754
|
-
type: 'object',
|
|
52779
|
+
type: 'array',
|
|
52755
52780
|
},
|
|
52756
52781
|
},
|
|
52757
52782
|
required: [
|
|
52758
52783
|
'connector_type',
|
|
52759
52784
|
'display_name',
|
|
52760
|
-
'
|
|
52785
|
+
'editable_fields',
|
|
52761
52786
|
],
|
|
52762
52787
|
type: 'object',
|
|
52763
52788
|
},
|
|
@@ -53182,6 +53207,7 @@ export default {
|
|
|
53182
53207
|
},
|
|
53183
53208
|
{
|
|
53184
53209
|
properties: {
|
|
53210
|
+
auth_token: { type: 'string' },
|
|
53185
53211
|
client_id: {
|
|
53186
53212
|
description: 'RMS client ID for authentication',
|
|
53187
53213
|
minLength: 1,
|
|
@@ -53908,6 +53934,12 @@ export default {
|
|
|
53908
53934
|
],
|
|
53909
53935
|
type: 'string',
|
|
53910
53936
|
},
|
|
53937
|
+
customization_profile_id: {
|
|
53938
|
+
description:
|
|
53939
|
+
'The ID of the customization profile to use for the portal.',
|
|
53940
|
+
format: 'uuid',
|
|
53941
|
+
type: 'string',
|
|
53942
|
+
},
|
|
53911
53943
|
features: {
|
|
53912
53944
|
default: { $ref: '#/components/schemas/access_code' },
|
|
53913
53945
|
properties: {
|
|
@@ -53930,12 +53962,6 @@ export default {
|
|
|
53930
53962
|
'Indicates whether the customer can customize the Instant Key profile for their properties.',
|
|
53931
53963
|
type: 'boolean',
|
|
53932
53964
|
},
|
|
53933
|
-
customization_profile_id: {
|
|
53934
|
-
description:
|
|
53935
|
-
'The ID of the customization profile to use for the portal.',
|
|
53936
|
-
format: 'uuid',
|
|
53937
|
-
type: 'string',
|
|
53938
|
-
},
|
|
53939
53965
|
exclude: {
|
|
53940
53966
|
default: false,
|
|
53941
53967
|
description:
|
|
@@ -54154,6 +54180,12 @@ export default {
|
|
|
54154
54180
|
},
|
|
54155
54181
|
type: 'object',
|
|
54156
54182
|
},
|
|
54183
|
+
locale: {
|
|
54184
|
+
default: 'auto',
|
|
54185
|
+
description: 'The locale to use for the portal.',
|
|
54186
|
+
enum: ['en-US', 'pt-PT', 'auto'],
|
|
54187
|
+
type: 'string',
|
|
54188
|
+
},
|
|
54157
54189
|
},
|
|
54158
54190
|
type: 'object',
|
|
54159
54191
|
},
|
|
@@ -54220,6 +54252,12 @@ export default {
|
|
|
54220
54252
|
],
|
|
54221
54253
|
type: 'string',
|
|
54222
54254
|
},
|
|
54255
|
+
customization_profile_id: {
|
|
54256
|
+
description:
|
|
54257
|
+
'The ID of the customization profile to use for the portal.',
|
|
54258
|
+
format: 'uuid',
|
|
54259
|
+
type: 'string',
|
|
54260
|
+
},
|
|
54223
54261
|
features: {
|
|
54224
54262
|
default: { $ref: '#/components/schemas/access_code' },
|
|
54225
54263
|
properties: {
|
|
@@ -54242,12 +54280,6 @@ export default {
|
|
|
54242
54280
|
'Indicates whether the customer can customize the Instant Key profile for their properties.',
|
|
54243
54281
|
type: 'boolean',
|
|
54244
54282
|
},
|
|
54245
|
-
customization_profile_id: {
|
|
54246
|
-
description:
|
|
54247
|
-
'The ID of the customization profile to use for the portal.',
|
|
54248
|
-
format: 'uuid',
|
|
54249
|
-
type: 'string',
|
|
54250
|
-
},
|
|
54251
54283
|
exclude: {
|
|
54252
54284
|
default: false,
|
|
54253
54285
|
description:
|
|
@@ -54466,6 +54498,12 @@ export default {
|
|
|
54466
54498
|
},
|
|
54467
54499
|
type: 'object',
|
|
54468
54500
|
},
|
|
54501
|
+
locale: {
|
|
54502
|
+
default: 'auto',
|
|
54503
|
+
description: 'The locale to use for the portal.',
|
|
54504
|
+
enum: ['en-US', 'pt-PT', 'auto'],
|
|
54505
|
+
type: 'string',
|
|
54506
|
+
},
|
|
54469
54507
|
},
|
|
54470
54508
|
type: 'object',
|
|
54471
54509
|
},
|
|
@@ -30495,8 +30495,6 @@ export type Routes = {
|
|
|
30495
30495
|
configure?: {
|
|
30496
30496
|
/** Whether to exclude this feature from the portal. */
|
|
30497
30497
|
exclude?: boolean
|
|
30498
|
-
/** The ID of the customization profile to use for the portal. */
|
|
30499
|
-
customization_profile_id?: string | undefined
|
|
30500
30498
|
/** Indicates whether the customer can customize the access automation rules for their properties. */
|
|
30501
30499
|
allow_access_automation_rule_customization?: boolean
|
|
30502
30500
|
/** Indicates whether the customer can customize the Instant Key profile for their properties. */
|
|
@@ -30557,6 +30555,10 @@ export type Routes = {
|
|
|
30557
30555
|
| undefined
|
|
30558
30556
|
}
|
|
30559
30557
|
| undefined
|
|
30558
|
+
/** The locale to use for the portal. */
|
|
30559
|
+
locale?: 'en-US' | 'pt-PT' | 'auto'
|
|
30560
|
+
/** The ID of the customization profile to use for the portal. */
|
|
30561
|
+
customization_profile_id?: string | undefined
|
|
30560
30562
|
} & {
|
|
30561
30563
|
customer_data?:
|
|
30562
30564
|
| {
|
|
@@ -61785,12 +61787,13 @@ export type Routes = {
|
|
|
61785
61787
|
connector_type: string
|
|
61786
61788
|
display_name: string
|
|
61787
61789
|
description?: string | undefined
|
|
61788
|
-
|
|
61789
|
-
|
|
61790
|
-
|
|
61791
|
-
|
|
61792
|
-
|
|
61793
|
-
|
|
61790
|
+
editable_fields: {
|
|
61791
|
+
name: string
|
|
61792
|
+
display_name: string
|
|
61793
|
+
description: string
|
|
61794
|
+
type: 'string' | 'string[]' | 'number' | 'boolean'
|
|
61795
|
+
required: boolean
|
|
61796
|
+
}[]
|
|
61794
61797
|
}[]
|
|
61795
61798
|
}
|
|
61796
61799
|
}
|
|
@@ -61909,6 +61912,7 @@ export type Routes = {
|
|
|
61909
61912
|
client_password: string
|
|
61910
61913
|
/** Optional property ID for single-property connectors */
|
|
61911
61914
|
property_id?: (string | number) | undefined
|
|
61915
|
+
auth_token?: string | undefined
|
|
61912
61916
|
}
|
|
61913
61917
|
}
|
|
61914
61918
|
commonParams: {}
|
|
@@ -64436,8 +64440,6 @@ export type Routes = {
|
|
|
64436
64440
|
configure?: {
|
|
64437
64441
|
/** Whether to exclude this feature from the portal. */
|
|
64438
64442
|
exclude?: boolean
|
|
64439
|
-
/** The ID of the customization profile to use for the portal. */
|
|
64440
|
-
customization_profile_id?: string | undefined
|
|
64441
64443
|
/** Indicates whether the customer can customize the access automation rules for their properties. */
|
|
64442
64444
|
allow_access_automation_rule_customization?: boolean
|
|
64443
64445
|
/** Indicates whether the customer can customize the Instant Key profile for their properties. */
|
|
@@ -64498,6 +64500,10 @@ export type Routes = {
|
|
|
64498
64500
|
| undefined
|
|
64499
64501
|
}
|
|
64500
64502
|
| undefined
|
|
64503
|
+
/** The locale to use for the portal. */
|
|
64504
|
+
locale?: 'en-US' | 'pt-PT' | 'auto'
|
|
64505
|
+
/** The ID of the customization profile to use for the portal. */
|
|
64506
|
+
customization_profile_id?: string | undefined
|
|
64501
64507
|
/** Business vertical of the customer portal. */
|
|
64502
64508
|
business_vertical?:
|
|
64503
64509
|
| (
|