@seamapi/types 1.473.0 → 1.475.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 +434 -2
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +953 -199
- package/dist/index.cjs +434 -2
- package/dist/index.cjs.map +1 -1
- package/lib/seam/connect/models/batch.d.ts +126 -0
- package/lib/seam/connect/models/batch.js +3 -0
- package/lib/seam/connect/models/batch.js.map +1 -1
- package/lib/seam/connect/models/customization_profiles/customization_profile.d.ts +21 -0
- package/lib/seam/connect/models/customization_profiles/customization_profile.js +9 -0
- package/lib/seam/connect/models/customization_profiles/customization_profile.js.map +1 -0
- package/lib/seam/connect/models/index.d.ts +1 -0
- package/lib/seam/connect/models/index.js +1 -0
- package/lib/seam/connect/models/index.js.map +1 -1
- package/lib/seam/connect/openapi.d.ts +544 -0
- package/lib/seam/connect/openapi.js +399 -0
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +126 -0
- package/lib/seam/connect/schemas.d.ts +1 -1
- package/lib/seam/connect/schemas.js +1 -1
- package/lib/seam/connect/schemas.js.map +1 -1
- package/package.json +1 -1
- package/src/lib/seam/connect/models/batch.ts +3 -0
- package/src/lib/seam/connect/models/customization_profiles/customization_profile.ts +11 -0
- package/src/lib/seam/connect/models/index.ts +1 -0
- package/src/lib/seam/connect/openapi.ts +399 -0
- package/src/lib/seam/connect/route-types.ts +130 -0
- package/src/lib/seam/connect/schemas.ts +1 -0
|
@@ -16879,6 +16879,30 @@ export type Routes = {
|
|
|
16879
16879
|
/** The customer key associated with this webview, if any. */
|
|
16880
16880
|
customer_key?: string | undefined;
|
|
16881
16881
|
}[] | undefined;
|
|
16882
|
+
access_methods?: {
|
|
16883
|
+
/** ID of the Seam workspace associated with the access method. */
|
|
16884
|
+
workspace_id: string;
|
|
16885
|
+
/** ID of the access method. */
|
|
16886
|
+
access_method_id: string;
|
|
16887
|
+
/** Display name of the access method. */
|
|
16888
|
+
display_name: string;
|
|
16889
|
+
/** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
|
|
16890
|
+
mode: 'code' | 'card' | 'mobile_key';
|
|
16891
|
+
/** Date and time at which the access method was created. */
|
|
16892
|
+
created_at: string;
|
|
16893
|
+
/** Date and time at which the access method was issued. */
|
|
16894
|
+
issued_at: string | null;
|
|
16895
|
+
/** Indicates whether the access method has been issued. */
|
|
16896
|
+
is_issued: boolean;
|
|
16897
|
+
/** URL of the Instant Key for mobile key access methods. */
|
|
16898
|
+
instant_key_url?: string | undefined;
|
|
16899
|
+
/** Token of the client session associated with the access method. */
|
|
16900
|
+
client_session_token?: string | undefined;
|
|
16901
|
+
/** Indicates whether encoding with an card encoder is required to issue or reissue the plastic card associated with the access method. */
|
|
16902
|
+
is_encoding_required?: boolean | undefined;
|
|
16903
|
+
/** The actual PIN code for code access methods. */
|
|
16904
|
+
code?: string | undefined;
|
|
16905
|
+
}[] | undefined;
|
|
16882
16906
|
};
|
|
16883
16907
|
};
|
|
16884
16908
|
};
|
|
@@ -75681,6 +75705,84 @@ export type Routes = {
|
|
|
75681
75705
|
};
|
|
75682
75706
|
};
|
|
75683
75707
|
};
|
|
75708
|
+
'/workspaces/customization_profiles/create': {
|
|
75709
|
+
route: '/workspaces/customization_profiles/create';
|
|
75710
|
+
method: 'POST';
|
|
75711
|
+
queryParams: {};
|
|
75712
|
+
jsonBody: {
|
|
75713
|
+
primary_color: string;
|
|
75714
|
+
secondary_color: string;
|
|
75715
|
+
};
|
|
75716
|
+
commonParams: {};
|
|
75717
|
+
formData: {};
|
|
75718
|
+
jsonResponse: {
|
|
75719
|
+
customization_profile: {
|
|
75720
|
+
workspace_id: string;
|
|
75721
|
+
customization_profile_id: string;
|
|
75722
|
+
logo_url?: string | undefined;
|
|
75723
|
+
primary_color?: string | undefined;
|
|
75724
|
+
secondary_color?: string | undefined;
|
|
75725
|
+
};
|
|
75726
|
+
};
|
|
75727
|
+
};
|
|
75728
|
+
'/workspaces/customization_profiles/get': {
|
|
75729
|
+
route: '/workspaces/customization_profiles/get';
|
|
75730
|
+
method: 'POST' | 'GET';
|
|
75731
|
+
queryParams: {};
|
|
75732
|
+
jsonBody: {};
|
|
75733
|
+
commonParams: {
|
|
75734
|
+
customization_profile_id: string;
|
|
75735
|
+
};
|
|
75736
|
+
formData: {};
|
|
75737
|
+
jsonResponse: {
|
|
75738
|
+
customization_profile: {
|
|
75739
|
+
workspace_id: string;
|
|
75740
|
+
customization_profile_id: string;
|
|
75741
|
+
logo_url?: string | undefined;
|
|
75742
|
+
primary_color?: string | undefined;
|
|
75743
|
+
secondary_color?: string | undefined;
|
|
75744
|
+
};
|
|
75745
|
+
};
|
|
75746
|
+
};
|
|
75747
|
+
'/workspaces/customization_profiles/list': {
|
|
75748
|
+
route: '/workspaces/customization_profiles/list';
|
|
75749
|
+
method: 'POST' | 'GET';
|
|
75750
|
+
queryParams: {};
|
|
75751
|
+
jsonBody: {};
|
|
75752
|
+
commonParams: {};
|
|
75753
|
+
formData: {};
|
|
75754
|
+
jsonResponse: {
|
|
75755
|
+
customization_profiles: {
|
|
75756
|
+
workspace_id: string;
|
|
75757
|
+
customization_profile_id: string;
|
|
75758
|
+
logo_url?: string | undefined;
|
|
75759
|
+
primary_color?: string | undefined;
|
|
75760
|
+
secondary_color?: string | undefined;
|
|
75761
|
+
}[];
|
|
75762
|
+
};
|
|
75763
|
+
};
|
|
75764
|
+
'/workspaces/customization_profiles/update': {
|
|
75765
|
+
route: '/workspaces/customization_profiles/update';
|
|
75766
|
+
method: 'POST' | 'PATCH';
|
|
75767
|
+
queryParams: {};
|
|
75768
|
+
jsonBody: {
|
|
75769
|
+
customization_profile_id: string;
|
|
75770
|
+
primary_color?: string | undefined;
|
|
75771
|
+
secondary_color?: string | undefined;
|
|
75772
|
+
};
|
|
75773
|
+
commonParams: {};
|
|
75774
|
+
formData: {};
|
|
75775
|
+
jsonResponse: {};
|
|
75776
|
+
};
|
|
75777
|
+
'/workspaces/customization_profiles/upload_images': {
|
|
75778
|
+
route: '/workspaces/customization_profiles/upload_images';
|
|
75779
|
+
method: 'POST';
|
|
75780
|
+
queryParams: {};
|
|
75781
|
+
jsonBody: {};
|
|
75782
|
+
commonParams: {};
|
|
75783
|
+
formData: {};
|
|
75784
|
+
jsonResponse: {};
|
|
75785
|
+
};
|
|
75684
75786
|
'/workspaces/find_resources': {
|
|
75685
75787
|
route: '/workspaces/find_resources';
|
|
75686
75788
|
method: 'GET' | 'POST';
|
|
@@ -79420,6 +79522,30 @@ export type Routes = {
|
|
|
79420
79522
|
/** The customer key associated with this webview, if any. */
|
|
79421
79523
|
customer_key?: string | undefined;
|
|
79422
79524
|
}[] | undefined;
|
|
79525
|
+
access_methods?: {
|
|
79526
|
+
/** ID of the Seam workspace associated with the access method. */
|
|
79527
|
+
workspace_id: string;
|
|
79528
|
+
/** ID of the access method. */
|
|
79529
|
+
access_method_id: string;
|
|
79530
|
+
/** Display name of the access method. */
|
|
79531
|
+
display_name: string;
|
|
79532
|
+
/** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
|
|
79533
|
+
mode: 'code' | 'card' | 'mobile_key';
|
|
79534
|
+
/** Date and time at which the access method was created. */
|
|
79535
|
+
created_at: string;
|
|
79536
|
+
/** Date and time at which the access method was issued. */
|
|
79537
|
+
issued_at: string | null;
|
|
79538
|
+
/** Indicates whether the access method has been issued. */
|
|
79539
|
+
is_issued: boolean;
|
|
79540
|
+
/** URL of the Instant Key for mobile key access methods. */
|
|
79541
|
+
instant_key_url?: string | undefined;
|
|
79542
|
+
/** Token of the client session associated with the access method. */
|
|
79543
|
+
client_session_token?: string | undefined;
|
|
79544
|
+
/** Indicates whether encoding with an card encoder is required to issue or reissue the plastic card associated with the access method. */
|
|
79545
|
+
is_encoding_required?: boolean | undefined;
|
|
79546
|
+
/** The actual PIN code for code access methods. */
|
|
79547
|
+
code?: string | undefined;
|
|
79548
|
+
}[] | undefined;
|
|
79423
79549
|
};
|
|
79424
79550
|
};
|
|
79425
79551
|
};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
export { access_code, acs_access_group, acs_credential, acs_encoder, acs_entrance, acs_system, acs_user, action_attempt, batch, bridge, bridge_client_session, building_block_type, client_session, common_failed_action_attempt, common_pending_action_attempt, common_succeeded_action_attempt, connect_webview, connected_account, custom_metadata, device, device_provider, instant_key, magic_link, noise_threshold, pagination, seam_event, thermostat_daily_program, thermostat_schedule, thermostat_weekly_program, unmanaged_access_code, unmanaged_acs_access_group, unmanaged_acs_credential, unmanaged_acs_user, unmanaged_device, user_identity, webhook, workspace, } from './models/index.js';
|
|
1
|
+
export { access_code, acs_access_group, acs_credential, acs_encoder, acs_entrance, acs_system, acs_user, action_attempt, batch, bridge, bridge_client_session, building_block_type, client_session, common_failed_action_attempt, common_pending_action_attempt, common_succeeded_action_attempt, connect_webview, connected_account, custom_metadata, customization_profile, device, device_provider, instant_key, magic_link, noise_threshold, pagination, seam_event, thermostat_daily_program, thermostat_schedule, thermostat_weekly_program, unmanaged_access_code, unmanaged_acs_access_group, unmanaged_acs_credential, unmanaged_acs_user, unmanaged_device, user_identity, webhook, workspace, } from './models/index.js';
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export { access_code, acs_access_group, acs_credential, acs_encoder, acs_entrance, acs_system, acs_user, action_attempt, batch, bridge, bridge_client_session, building_block_type, client_session, common_failed_action_attempt, common_pending_action_attempt, common_succeeded_action_attempt, connect_webview, connected_account, custom_metadata, device, device_provider, instant_key, magic_link, noise_threshold, pagination, seam_event, thermostat_daily_program, thermostat_schedule, thermostat_weekly_program, unmanaged_access_code, unmanaged_acs_access_group, unmanaged_acs_credential, unmanaged_acs_user, unmanaged_device, user_identity, webhook, workspace, } from './models/index.js';
|
|
1
|
+
export { access_code, acs_access_group, acs_credential, acs_encoder, acs_entrance, acs_system, acs_user, action_attempt, batch, bridge, bridge_client_session, building_block_type, client_session, common_failed_action_attempt, common_pending_action_attempt, common_succeeded_action_attempt, connect_webview, connected_account, custom_metadata, customization_profile, device, device_provider, instant_key, magic_link, noise_threshold, pagination, seam_event, thermostat_daily_program, thermostat_schedule, thermostat_weekly_program, unmanaged_access_code, unmanaged_acs_access_group, unmanaged_acs_credential, unmanaged_acs_user, unmanaged_device, user_identity, webhook, workspace, } from './models/index.js';
|
|
2
2
|
//# sourceMappingURL=schemas.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"schemas.js","sourceRoot":"","sources":["../../../src/lib/seam/connect/schemas.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,WAAW,EACX,gBAAgB,EAChB,cAAc,EACd,WAAW,EACX,YAAY,EACZ,UAAU,EACV,QAAQ,EACR,cAAc,EACd,KAAK,EACL,MAAM,EACN,qBAAqB,EACrB,mBAAmB,EACnB,cAAc,EACd,4BAA4B,EAC5B,6BAA6B,EAC7B,+BAA+B,EAC/B,eAAe,EACf,iBAAiB,EACjB,eAAe,EACf,MAAM,EACN,eAAe,EACf,WAAW,EACX,UAAU,EACV,eAAe,EACf,UAAU,EACV,UAAU,EACV,wBAAwB,EACxB,mBAAmB,EACnB,yBAAyB,EACzB,qBAAqB,EACrB,0BAA0B,EAC1B,wBAAwB,EACxB,kBAAkB,EAClB,gBAAgB,EAChB,aAAa,EACb,OAAO,EACP,SAAS,GACV,MAAM,mBAAmB,CAAA"}
|
|
1
|
+
{"version":3,"file":"schemas.js","sourceRoot":"","sources":["../../../src/lib/seam/connect/schemas.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,WAAW,EACX,gBAAgB,EAChB,cAAc,EACd,WAAW,EACX,YAAY,EACZ,UAAU,EACV,QAAQ,EACR,cAAc,EACd,KAAK,EACL,MAAM,EACN,qBAAqB,EACrB,mBAAmB,EACnB,cAAc,EACd,4BAA4B,EAC5B,6BAA6B,EAC7B,+BAA+B,EAC/B,eAAe,EACf,iBAAiB,EACjB,eAAe,EACf,qBAAqB,EACrB,MAAM,EACN,eAAe,EACf,WAAW,EACX,UAAU,EACV,eAAe,EACf,UAAU,EACV,UAAU,EACV,wBAAwB,EACxB,mBAAmB,EACnB,yBAAyB,EACzB,qBAAqB,EACrB,0BAA0B,EAC1B,wBAAwB,EACxB,kBAAkB,EAClB,gBAAgB,EAChB,aAAa,EACb,OAAO,EACP,SAAS,GACV,MAAM,mBAAmB,CAAA"}
|
package/package.json
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { z } from 'zod'
|
|
2
2
|
|
|
3
|
+
import { access_method } from './access-grants/access-method.js'
|
|
3
4
|
import {
|
|
4
5
|
acs_access_group,
|
|
5
6
|
unmanaged_acs_access_group,
|
|
@@ -63,6 +64,7 @@ export const workspaces_batch = z
|
|
|
63
64
|
unmanaged_acs_access_groups: unmanaged_acs_access_group.array().optional(),
|
|
64
65
|
unmanaged_devices: unmanaged_device.array().optional(),
|
|
65
66
|
connect_webviews: connect_webview.array().optional(),
|
|
67
|
+
access_methods: access_method.array().optional(),
|
|
66
68
|
})
|
|
67
69
|
.describe('A batch of workspace resources.')
|
|
68
70
|
|
|
@@ -89,6 +91,7 @@ export const batch = z
|
|
|
89
91
|
unmanaged_acs_access_groups: unmanaged_acs_access_group.array().optional(),
|
|
90
92
|
unmanaged_devices: unmanaged_device.array().optional(),
|
|
91
93
|
connect_webviews: connect_webview.array().optional(),
|
|
94
|
+
access_methods: access_method.array().optional(),
|
|
92
95
|
})
|
|
93
96
|
.describe('A batch of workspace resources.')
|
|
94
97
|
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import { z } from 'zod'
|
|
2
|
+
|
|
3
|
+
export const customization_profile = z.object({
|
|
4
|
+
workspace_id: z.string().uuid(),
|
|
5
|
+
customization_profile_id: z.string().uuid(),
|
|
6
|
+
logo_url: z.string().optional(),
|
|
7
|
+
primary_color: z.string().optional(),
|
|
8
|
+
secondary_color: z.string().optional(),
|
|
9
|
+
})
|
|
10
|
+
|
|
11
|
+
export type CustomizationProfile = z.infer<typeof customization_profile>
|
|
@@ -13,6 +13,7 @@ export * from './customer/access-grant-resources.js'
|
|
|
13
13
|
export * from './customer/index.js'
|
|
14
14
|
export * from './customer/location-resources.js'
|
|
15
15
|
export * from './customer/user-identity-resources.js'
|
|
16
|
+
export * from './customization_profiles/customization_profile.js'
|
|
16
17
|
export * from './devices/index.js'
|
|
17
18
|
export * from './events/index.js'
|
|
18
19
|
export * from './instant-keys/index.js'
|
|
@@ -29149,6 +29149,10 @@ export default {
|
|
|
29149
29149
|
batch: {
|
|
29150
29150
|
description: 'A batch of workspace resources.',
|
|
29151
29151
|
properties: {
|
|
29152
|
+
access_methods: {
|
|
29153
|
+
items: { $ref: '#/components/schemas/access_method' },
|
|
29154
|
+
type: 'array',
|
|
29155
|
+
},
|
|
29152
29156
|
acs_access_groups: {
|
|
29153
29157
|
items: {
|
|
29154
29158
|
$ref: '#/components/schemas/acs_access_group',
|
|
@@ -29308,6 +29312,10 @@ export default {
|
|
|
29308
29312
|
batch: {
|
|
29309
29313
|
description: 'A batch of workspace resources.',
|
|
29310
29314
|
properties: {
|
|
29315
|
+
access_methods: {
|
|
29316
|
+
items: { $ref: '#/components/schemas/access_method' },
|
|
29317
|
+
type: 'array',
|
|
29318
|
+
},
|
|
29311
29319
|
acs_access_groups: {
|
|
29312
29320
|
items: {
|
|
29313
29321
|
$ref: '#/components/schemas/acs_access_group',
|
|
@@ -56048,6 +56056,389 @@ export default {
|
|
|
56048
56056
|
'x-title': 'Create a Workspace',
|
|
56049
56057
|
},
|
|
56050
56058
|
},
|
|
56059
|
+
'/workspaces/customization_profiles/create': {
|
|
56060
|
+
post: {
|
|
56061
|
+
description: 'Updates the customization profile for the workspace.',
|
|
56062
|
+
operationId: 'workspacesCustomizationProfilesCreatePost',
|
|
56063
|
+
requestBody: {
|
|
56064
|
+
content: {
|
|
56065
|
+
'application/json': {
|
|
56066
|
+
schema: {
|
|
56067
|
+
properties: {
|
|
56068
|
+
primary_color: { type: 'string' },
|
|
56069
|
+
secondary_color: { type: 'string' },
|
|
56070
|
+
},
|
|
56071
|
+
required: ['primary_color', 'secondary_color'],
|
|
56072
|
+
type: 'object',
|
|
56073
|
+
},
|
|
56074
|
+
},
|
|
56075
|
+
},
|
|
56076
|
+
},
|
|
56077
|
+
responses: {
|
|
56078
|
+
200: {
|
|
56079
|
+
content: {
|
|
56080
|
+
'application/json': {
|
|
56081
|
+
schema: {
|
|
56082
|
+
properties: {
|
|
56083
|
+
customization_profile: {
|
|
56084
|
+
properties: {
|
|
56085
|
+
customization_profile_id: {
|
|
56086
|
+
format: 'uuid',
|
|
56087
|
+
type: 'string',
|
|
56088
|
+
},
|
|
56089
|
+
logo_url: { type: 'string' },
|
|
56090
|
+
primary_color: { type: 'string' },
|
|
56091
|
+
secondary_color: { type: 'string' },
|
|
56092
|
+
workspace_id: { format: 'uuid', type: 'string' },
|
|
56093
|
+
},
|
|
56094
|
+
required: ['workspace_id', 'customization_profile_id'],
|
|
56095
|
+
type: 'object',
|
|
56096
|
+
},
|
|
56097
|
+
ok: { type: 'boolean' },
|
|
56098
|
+
},
|
|
56099
|
+
required: ['customization_profile', 'ok'],
|
|
56100
|
+
type: 'object',
|
|
56101
|
+
},
|
|
56102
|
+
},
|
|
56103
|
+
},
|
|
56104
|
+
description: 'OK',
|
|
56105
|
+
},
|
|
56106
|
+
400: { description: 'Bad Request' },
|
|
56107
|
+
401: { description: 'Unauthorized' },
|
|
56108
|
+
},
|
|
56109
|
+
security: [{ client_session_with_customer: [] }],
|
|
56110
|
+
summary: '/workspaces/customization_profiles/create',
|
|
56111
|
+
tags: ['/workspaces'],
|
|
56112
|
+
'x-fern-sdk-group-name': ['workspaces', 'customization_profiles'],
|
|
56113
|
+
'x-fern-sdk-method-name': 'create',
|
|
56114
|
+
'x-fern-sdk-return-value': 'customization_profile',
|
|
56115
|
+
'x-response-key': 'customization_profile',
|
|
56116
|
+
'x-title': 'Update Customization Profile',
|
|
56117
|
+
},
|
|
56118
|
+
},
|
|
56119
|
+
'/workspaces/customization_profiles/get': {
|
|
56120
|
+
get: {
|
|
56121
|
+
description: 'Retrieves the customization profile for the workspace.',
|
|
56122
|
+
operationId: 'workspacesCustomizationProfilesGetGet',
|
|
56123
|
+
parameters: [
|
|
56124
|
+
{
|
|
56125
|
+
in: 'query',
|
|
56126
|
+
name: 'customization_profile_id',
|
|
56127
|
+
required: true,
|
|
56128
|
+
schema: { format: 'uuid', type: 'string' },
|
|
56129
|
+
},
|
|
56130
|
+
],
|
|
56131
|
+
responses: {
|
|
56132
|
+
200: {
|
|
56133
|
+
content: {
|
|
56134
|
+
'application/json': {
|
|
56135
|
+
schema: {
|
|
56136
|
+
properties: {
|
|
56137
|
+
customization_profile: {
|
|
56138
|
+
properties: {
|
|
56139
|
+
customization_profile_id: {
|
|
56140
|
+
format: 'uuid',
|
|
56141
|
+
type: 'string',
|
|
56142
|
+
},
|
|
56143
|
+
logo_url: { type: 'string' },
|
|
56144
|
+
primary_color: { type: 'string' },
|
|
56145
|
+
secondary_color: { type: 'string' },
|
|
56146
|
+
workspace_id: { format: 'uuid', type: 'string' },
|
|
56147
|
+
},
|
|
56148
|
+
required: ['workspace_id', 'customization_profile_id'],
|
|
56149
|
+
type: 'object',
|
|
56150
|
+
},
|
|
56151
|
+
ok: { type: 'boolean' },
|
|
56152
|
+
},
|
|
56153
|
+
required: ['customization_profile', 'ok'],
|
|
56154
|
+
type: 'object',
|
|
56155
|
+
},
|
|
56156
|
+
},
|
|
56157
|
+
},
|
|
56158
|
+
description: 'OK',
|
|
56159
|
+
},
|
|
56160
|
+
400: { description: 'Bad Request' },
|
|
56161
|
+
401: { description: 'Unauthorized' },
|
|
56162
|
+
},
|
|
56163
|
+
security: [{ client_session_with_customer: [] }],
|
|
56164
|
+
summary: '/workspaces/customization_profiles/get',
|
|
56165
|
+
tags: ['/workspaces'],
|
|
56166
|
+
'x-fern-sdk-group-name': ['workspaces', 'customization_profiles'],
|
|
56167
|
+
'x-fern-sdk-method-name': 'get',
|
|
56168
|
+
'x-fern-sdk-return-value': 'customization_profile',
|
|
56169
|
+
'x-response-key': 'customization_profile',
|
|
56170
|
+
'x-title': 'Get Customization Profile',
|
|
56171
|
+
},
|
|
56172
|
+
post: {
|
|
56173
|
+
description: 'Retrieves the customization profile for the workspace.',
|
|
56174
|
+
operationId: 'workspacesCustomizationProfilesGetPost',
|
|
56175
|
+
requestBody: {
|
|
56176
|
+
content: {
|
|
56177
|
+
'application/json': {
|
|
56178
|
+
schema: {
|
|
56179
|
+
properties: {
|
|
56180
|
+
customization_profile_id: { format: 'uuid', type: 'string' },
|
|
56181
|
+
},
|
|
56182
|
+
required: ['customization_profile_id'],
|
|
56183
|
+
type: 'object',
|
|
56184
|
+
},
|
|
56185
|
+
},
|
|
56186
|
+
},
|
|
56187
|
+
},
|
|
56188
|
+
responses: {
|
|
56189
|
+
200: {
|
|
56190
|
+
content: {
|
|
56191
|
+
'application/json': {
|
|
56192
|
+
schema: {
|
|
56193
|
+
properties: {
|
|
56194
|
+
customization_profile: {
|
|
56195
|
+
properties: {
|
|
56196
|
+
customization_profile_id: {
|
|
56197
|
+
format: 'uuid',
|
|
56198
|
+
type: 'string',
|
|
56199
|
+
},
|
|
56200
|
+
logo_url: { type: 'string' },
|
|
56201
|
+
primary_color: { type: 'string' },
|
|
56202
|
+
secondary_color: { type: 'string' },
|
|
56203
|
+
workspace_id: { format: 'uuid', type: 'string' },
|
|
56204
|
+
},
|
|
56205
|
+
required: ['workspace_id', 'customization_profile_id'],
|
|
56206
|
+
type: 'object',
|
|
56207
|
+
},
|
|
56208
|
+
ok: { type: 'boolean' },
|
|
56209
|
+
},
|
|
56210
|
+
required: ['customization_profile', 'ok'],
|
|
56211
|
+
type: 'object',
|
|
56212
|
+
},
|
|
56213
|
+
},
|
|
56214
|
+
},
|
|
56215
|
+
description: 'OK',
|
|
56216
|
+
},
|
|
56217
|
+
400: { description: 'Bad Request' },
|
|
56218
|
+
401: { description: 'Unauthorized' },
|
|
56219
|
+
},
|
|
56220
|
+
security: [{ client_session_with_customer: [] }],
|
|
56221
|
+
summary: '/workspaces/customization_profiles/get',
|
|
56222
|
+
tags: ['/workspaces'],
|
|
56223
|
+
'x-fern-sdk-group-name': ['workspaces', 'customization_profiles'],
|
|
56224
|
+
'x-fern-sdk-method-name': 'get',
|
|
56225
|
+
'x-fern-sdk-return-value': 'customization_profile',
|
|
56226
|
+
'x-response-key': 'customization_profile',
|
|
56227
|
+
'x-title': 'Get Customization Profile',
|
|
56228
|
+
},
|
|
56229
|
+
},
|
|
56230
|
+
'/workspaces/customization_profiles/list': {
|
|
56231
|
+
get: {
|
|
56232
|
+
description: 'Retrieves the customization profile for the workspace.',
|
|
56233
|
+
operationId: 'workspacesCustomizationProfilesListGet',
|
|
56234
|
+
responses: {
|
|
56235
|
+
200: {
|
|
56236
|
+
content: {
|
|
56237
|
+
'application/json': {
|
|
56238
|
+
schema: {
|
|
56239
|
+
properties: {
|
|
56240
|
+
customization_profiles: {
|
|
56241
|
+
items: {
|
|
56242
|
+
properties: {
|
|
56243
|
+
customization_profile_id: {
|
|
56244
|
+
format: 'uuid',
|
|
56245
|
+
type: 'string',
|
|
56246
|
+
},
|
|
56247
|
+
logo_url: { type: 'string' },
|
|
56248
|
+
primary_color: { type: 'string' },
|
|
56249
|
+
secondary_color: { type: 'string' },
|
|
56250
|
+
workspace_id: { format: 'uuid', type: 'string' },
|
|
56251
|
+
},
|
|
56252
|
+
required: ['workspace_id', 'customization_profile_id'],
|
|
56253
|
+
type: 'object',
|
|
56254
|
+
},
|
|
56255
|
+
type: 'array',
|
|
56256
|
+
},
|
|
56257
|
+
ok: { type: 'boolean' },
|
|
56258
|
+
},
|
|
56259
|
+
required: ['customization_profiles', 'ok'],
|
|
56260
|
+
type: 'object',
|
|
56261
|
+
},
|
|
56262
|
+
},
|
|
56263
|
+
},
|
|
56264
|
+
description: 'OK',
|
|
56265
|
+
},
|
|
56266
|
+
400: { description: 'Bad Request' },
|
|
56267
|
+
401: { description: 'Unauthorized' },
|
|
56268
|
+
},
|
|
56269
|
+
security: [{ client_session_with_customer: [] }],
|
|
56270
|
+
summary: '/workspaces/customization_profiles/list',
|
|
56271
|
+
tags: ['/workspaces'],
|
|
56272
|
+
'x-fern-sdk-group-name': ['workspaces', 'customization_profiles'],
|
|
56273
|
+
'x-fern-sdk-method-name': 'list',
|
|
56274
|
+
'x-fern-sdk-return-value': 'customization_profiles',
|
|
56275
|
+
'x-response-key': 'customization_profiles',
|
|
56276
|
+
'x-title': 'Get Customization Profile',
|
|
56277
|
+
},
|
|
56278
|
+
post: {
|
|
56279
|
+
description: 'Retrieves the customization profile for the workspace.',
|
|
56280
|
+
operationId: 'workspacesCustomizationProfilesListPost',
|
|
56281
|
+
responses: {
|
|
56282
|
+
200: {
|
|
56283
|
+
content: {
|
|
56284
|
+
'application/json': {
|
|
56285
|
+
schema: {
|
|
56286
|
+
properties: {
|
|
56287
|
+
customization_profiles: {
|
|
56288
|
+
items: {
|
|
56289
|
+
properties: {
|
|
56290
|
+
customization_profile_id: {
|
|
56291
|
+
format: 'uuid',
|
|
56292
|
+
type: 'string',
|
|
56293
|
+
},
|
|
56294
|
+
logo_url: { type: 'string' },
|
|
56295
|
+
primary_color: { type: 'string' },
|
|
56296
|
+
secondary_color: { type: 'string' },
|
|
56297
|
+
workspace_id: { format: 'uuid', type: 'string' },
|
|
56298
|
+
},
|
|
56299
|
+
required: ['workspace_id', 'customization_profile_id'],
|
|
56300
|
+
type: 'object',
|
|
56301
|
+
},
|
|
56302
|
+
type: 'array',
|
|
56303
|
+
},
|
|
56304
|
+
ok: { type: 'boolean' },
|
|
56305
|
+
},
|
|
56306
|
+
required: ['customization_profiles', 'ok'],
|
|
56307
|
+
type: 'object',
|
|
56308
|
+
},
|
|
56309
|
+
},
|
|
56310
|
+
},
|
|
56311
|
+
description: 'OK',
|
|
56312
|
+
},
|
|
56313
|
+
400: { description: 'Bad Request' },
|
|
56314
|
+
401: { description: 'Unauthorized' },
|
|
56315
|
+
},
|
|
56316
|
+
security: [{ client_session_with_customer: [] }],
|
|
56317
|
+
summary: '/workspaces/customization_profiles/list',
|
|
56318
|
+
tags: ['/workspaces'],
|
|
56319
|
+
'x-fern-sdk-group-name': ['workspaces', 'customization_profiles'],
|
|
56320
|
+
'x-fern-sdk-method-name': 'list',
|
|
56321
|
+
'x-fern-sdk-return-value': 'customization_profiles',
|
|
56322
|
+
'x-response-key': 'customization_profiles',
|
|
56323
|
+
'x-title': 'Get Customization Profile',
|
|
56324
|
+
},
|
|
56325
|
+
},
|
|
56326
|
+
'/workspaces/customization_profiles/update': {
|
|
56327
|
+
patch: {
|
|
56328
|
+
description: 'Updates the customization profile for the workspace.',
|
|
56329
|
+
operationId: 'workspacesCustomizationProfilesUpdatePatch',
|
|
56330
|
+
requestBody: {
|
|
56331
|
+
content: {
|
|
56332
|
+
'application/json': {
|
|
56333
|
+
schema: {
|
|
56334
|
+
properties: {
|
|
56335
|
+
customization_profile_id: { format: 'uuid', type: 'string' },
|
|
56336
|
+
primary_color: { type: 'string' },
|
|
56337
|
+
secondary_color: { type: 'string' },
|
|
56338
|
+
},
|
|
56339
|
+
required: ['customization_profile_id'],
|
|
56340
|
+
type: 'object',
|
|
56341
|
+
},
|
|
56342
|
+
},
|
|
56343
|
+
},
|
|
56344
|
+
},
|
|
56345
|
+
responses: {
|
|
56346
|
+
200: {
|
|
56347
|
+
content: {
|
|
56348
|
+
'application/json': {
|
|
56349
|
+
schema: {
|
|
56350
|
+
properties: { ok: { type: 'boolean' } },
|
|
56351
|
+
required: ['ok'],
|
|
56352
|
+
type: 'object',
|
|
56353
|
+
},
|
|
56354
|
+
},
|
|
56355
|
+
},
|
|
56356
|
+
description: 'OK',
|
|
56357
|
+
},
|
|
56358
|
+
400: { description: 'Bad Request' },
|
|
56359
|
+
401: { description: 'Unauthorized' },
|
|
56360
|
+
},
|
|
56361
|
+
security: [{ client_session_with_customer: [] }],
|
|
56362
|
+
summary: '/workspaces/customization_profiles/update',
|
|
56363
|
+
tags: ['/workspaces'],
|
|
56364
|
+
'x-fern-sdk-group-name': ['workspaces', 'customization_profiles'],
|
|
56365
|
+
'x-fern-sdk-method-name': 'update',
|
|
56366
|
+
'x-response-key': null,
|
|
56367
|
+
'x-title': 'Update Customization Profile',
|
|
56368
|
+
},
|
|
56369
|
+
post: {
|
|
56370
|
+
description: 'Updates the customization profile for the workspace.',
|
|
56371
|
+
operationId: 'workspacesCustomizationProfilesUpdatePost',
|
|
56372
|
+
requestBody: {
|
|
56373
|
+
content: {
|
|
56374
|
+
'application/json': {
|
|
56375
|
+
schema: {
|
|
56376
|
+
properties: {
|
|
56377
|
+
customization_profile_id: { format: 'uuid', type: 'string' },
|
|
56378
|
+
primary_color: { type: 'string' },
|
|
56379
|
+
secondary_color: { type: 'string' },
|
|
56380
|
+
},
|
|
56381
|
+
required: ['customization_profile_id'],
|
|
56382
|
+
type: 'object',
|
|
56383
|
+
},
|
|
56384
|
+
},
|
|
56385
|
+
},
|
|
56386
|
+
},
|
|
56387
|
+
responses: {
|
|
56388
|
+
200: {
|
|
56389
|
+
content: {
|
|
56390
|
+
'application/json': {
|
|
56391
|
+
schema: {
|
|
56392
|
+
properties: { ok: { type: 'boolean' } },
|
|
56393
|
+
required: ['ok'],
|
|
56394
|
+
type: 'object',
|
|
56395
|
+
},
|
|
56396
|
+
},
|
|
56397
|
+
},
|
|
56398
|
+
description: 'OK',
|
|
56399
|
+
},
|
|
56400
|
+
400: { description: 'Bad Request' },
|
|
56401
|
+
401: { description: 'Unauthorized' },
|
|
56402
|
+
},
|
|
56403
|
+
security: [{ client_session_with_customer: [] }],
|
|
56404
|
+
summary: '/workspaces/customization_profiles/update',
|
|
56405
|
+
tags: ['/workspaces'],
|
|
56406
|
+
'x-fern-sdk-group-name': ['workspaces', 'customization_profiles'],
|
|
56407
|
+
'x-fern-sdk-method-name': 'update',
|
|
56408
|
+
'x-response-key': null,
|
|
56409
|
+
'x-title': 'Update Customization Profile',
|
|
56410
|
+
},
|
|
56411
|
+
},
|
|
56412
|
+
'/workspaces/customization_profiles/upload_images': {
|
|
56413
|
+
post: {
|
|
56414
|
+
description: 'Uploads a logo for the customization profile.',
|
|
56415
|
+
operationId: 'workspacesCustomizationProfilesUploadImagesPost',
|
|
56416
|
+
responses: {
|
|
56417
|
+
200: {
|
|
56418
|
+
content: {
|
|
56419
|
+
'application/json': {
|
|
56420
|
+
schema: {
|
|
56421
|
+
properties: { ok: { type: 'boolean' } },
|
|
56422
|
+
required: ['ok'],
|
|
56423
|
+
type: 'object',
|
|
56424
|
+
},
|
|
56425
|
+
},
|
|
56426
|
+
},
|
|
56427
|
+
description: 'OK',
|
|
56428
|
+
},
|
|
56429
|
+
400: { description: 'Bad Request' },
|
|
56430
|
+
401: { description: 'Unauthorized' },
|
|
56431
|
+
},
|
|
56432
|
+
security: [{ client_session_with_customer: [] }],
|
|
56433
|
+
summary: '/workspaces/customization_profiles/upload_images',
|
|
56434
|
+
tags: ['/workspaces'],
|
|
56435
|
+
'x-fern-sdk-group-name': ['workspaces', 'customization_profiles'],
|
|
56436
|
+
'x-fern-sdk-method-name': 'upload_images',
|
|
56437
|
+
'x-response-key': null,
|
|
56438
|
+
'x-title': 'Upload Customization Profile Logo',
|
|
56439
|
+
'x-undocumented': 'Internal endpoint for customer portals.',
|
|
56440
|
+
},
|
|
56441
|
+
},
|
|
56051
56442
|
'/workspaces/find_resources': {
|
|
56052
56443
|
get: {
|
|
56053
56444
|
description: 'Search for resources inside a workspace.',
|
|
@@ -56069,6 +56460,10 @@ export default {
|
|
|
56069
56460
|
batch: {
|
|
56070
56461
|
description: 'A batch of workspace resources.',
|
|
56071
56462
|
properties: {
|
|
56463
|
+
access_methods: {
|
|
56464
|
+
items: { $ref: '#/components/schemas/access_method' },
|
|
56465
|
+
type: 'array',
|
|
56466
|
+
},
|
|
56072
56467
|
acs_access_groups: {
|
|
56073
56468
|
items: {
|
|
56074
56469
|
$ref: '#/components/schemas/acs_access_group',
|
|
@@ -56203,6 +56598,10 @@ export default {
|
|
|
56203
56598
|
batch: {
|
|
56204
56599
|
description: 'A batch of workspace resources.',
|
|
56205
56600
|
properties: {
|
|
56601
|
+
access_methods: {
|
|
56602
|
+
items: { $ref: '#/components/schemas/access_method' },
|
|
56603
|
+
type: 'array',
|
|
56604
|
+
},
|
|
56206
56605
|
acs_access_groups: {
|
|
56207
56606
|
items: {
|
|
56208
56607
|
$ref: '#/components/schemas/acs_access_group',
|