@seamapi/types 1.1120.0 → 1.1122.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/lib/seam/connect/models/customization-profiles/customization-profile.d.ts +3 -0
- package/lib/seam/connect/models/customization-profiles/customization-profile.js +3 -0
- package/lib/seam/connect/models/customization-profiles/customization-profile.js.map +1 -1
- package/lib/seam/connect/openapi.js +90 -2
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +39 -0
- package/package.json +1 -1
- package/src/lib/seam/connect/models/customization-profiles/customization-profile.ts +5 -0
- package/src/lib/seam/connect/openapi.ts +98 -2
- package/src/lib/seam/connect/route-types.ts +39 -0
|
@@ -88295,6 +88295,8 @@ export type Routes = {
|
|
|
88295
88295
|
/** Key of the customer that owns the profile, or `null` for a workspace-level profile. A customer can own a profile without using it; the profile a customer uses is `customization_profile_id` on the customer. */
|
|
88296
88296
|
customer_key: string | null;
|
|
88297
88297
|
created_at: string;
|
|
88298
|
+
/** Whether this is the workspace's default profile, used for access grants and Instant Keys created without a customization profile. */
|
|
88299
|
+
is_workspace_default: boolean;
|
|
88298
88300
|
logo_url?: string | undefined;
|
|
88299
88301
|
primary_color?: string | undefined;
|
|
88300
88302
|
secondary_color?: string | undefined;
|
|
@@ -91747,6 +91749,34 @@ export type Routes = {
|
|
|
91747
91749
|
};
|
|
91748
91750
|
maxDuration: undefined;
|
|
91749
91751
|
};
|
|
91752
|
+
'/seam/customer/v1/automations/get_guest_phone_last4_usage': {
|
|
91753
|
+
route: '/seam/customer/v1/automations/get_guest_phone_last4_usage';
|
|
91754
|
+
method: 'GET' | 'POST';
|
|
91755
|
+
queryParams: {};
|
|
91756
|
+
jsonBody: {};
|
|
91757
|
+
commonParams: {};
|
|
91758
|
+
formData: {};
|
|
91759
|
+
jsonResponse: {
|
|
91760
|
+
/** Whether the workspace-level automation uses prefer_guest_phone_last4_as_code. */
|
|
91761
|
+
is_used_by_workspace: boolean;
|
|
91762
|
+
/** Number of customers whose automation uses prefer_guest_phone_last4_as_code. */
|
|
91763
|
+
customer_count: number;
|
|
91764
|
+
};
|
|
91765
|
+
maxDuration: undefined;
|
|
91766
|
+
};
|
|
91767
|
+
'/seam/customer/v1/automations/switch_to_guest_phone_last_digits': {
|
|
91768
|
+
route: '/seam/customer/v1/automations/switch_to_guest_phone_last_digits';
|
|
91769
|
+
method: 'POST';
|
|
91770
|
+
queryParams: {};
|
|
91771
|
+
jsonBody: {};
|
|
91772
|
+
commonParams: {};
|
|
91773
|
+
formData: {};
|
|
91774
|
+
jsonResponse: {
|
|
91775
|
+
/** Number of automations that were switched. */
|
|
91776
|
+
switched_count: number;
|
|
91777
|
+
};
|
|
91778
|
+
maxDuration: undefined;
|
|
91779
|
+
};
|
|
91750
91780
|
'/seam/customer/v1/automations/update': {
|
|
91751
91781
|
route: '/seam/customer/v1/automations/update';
|
|
91752
91782
|
method: 'PATCH' | 'POST';
|
|
@@ -148730,6 +148760,8 @@ export type Routes = {
|
|
|
148730
148760
|
/** Key of the customer that owns the profile, or `null` for a workspace-level profile. A customer can own a profile without using it; the profile a customer uses is `customization_profile_id` on the customer. */
|
|
148731
148761
|
customer_key: string | null;
|
|
148732
148762
|
created_at: string;
|
|
148763
|
+
/** Whether this is the workspace's default profile, used for access grants and Instant Keys created without a customization profile. */
|
|
148764
|
+
is_workspace_default: boolean;
|
|
148733
148765
|
logo_url?: string | undefined;
|
|
148734
148766
|
primary_color?: string | undefined;
|
|
148735
148767
|
secondary_color?: string | undefined;
|
|
@@ -148891,6 +148923,8 @@ export type Routes = {
|
|
|
148891
148923
|
/** Key of the customer that owns the profile, or `null` for a workspace-level profile. A customer can own a profile without using it; the profile a customer uses is `customization_profile_id` on the customer. */
|
|
148892
148924
|
customer_key: string | null;
|
|
148893
148925
|
created_at: string;
|
|
148926
|
+
/** Whether this is the workspace's default profile, used for access grants and Instant Keys created without a customization profile. */
|
|
148927
|
+
is_workspace_default: boolean;
|
|
148894
148928
|
logo_url?: string | undefined;
|
|
148895
148929
|
primary_color?: string | undefined;
|
|
148896
148930
|
secondary_color?: string | undefined;
|
|
@@ -149052,6 +149086,8 @@ export type Routes = {
|
|
|
149052
149086
|
/** Key of the customer that owns the profile, or `null` for a workspace-level profile. A customer can own a profile without using it; the profile a customer uses is `customization_profile_id` on the customer. */
|
|
149053
149087
|
customer_key: string | null;
|
|
149054
149088
|
created_at: string;
|
|
149089
|
+
/** Whether this is the workspace's default profile, used for access grants and Instant Keys created without a customization profile. */
|
|
149090
|
+
is_workspace_default: boolean;
|
|
149055
149091
|
logo_url?: string | undefined;
|
|
149056
149092
|
primary_color?: string | undefined;
|
|
149057
149093
|
secondary_color?: string | undefined;
|
|
@@ -149339,6 +149375,7 @@ export type Routes = {
|
|
|
149339
149375
|
[x: string]: string;
|
|
149340
149376
|
};
|
|
149341
149377
|
} | undefined) | null;
|
|
149378
|
+
is_workspace_default?: boolean | undefined;
|
|
149342
149379
|
};
|
|
149343
149380
|
commonParams: {};
|
|
149344
149381
|
formData: {};
|
|
@@ -160516,6 +160553,8 @@ export type Routes = {
|
|
|
160516
160553
|
/** Key of the customer that owns the profile, or `null` for a workspace-level profile. A customer can own a profile without using it; the profile a customer uses is `customization_profile_id` on the customer. */
|
|
160517
160554
|
customer_key: string | null;
|
|
160518
160555
|
created_at: string;
|
|
160556
|
+
/** Whether this is the workspace's default profile, used for access grants and Instant Keys created without a customization profile. */
|
|
160557
|
+
is_workspace_default: boolean;
|
|
160519
160558
|
logo_url?: string | undefined;
|
|
160520
160559
|
primary_color?: string | undefined;
|
|
160521
160560
|
secondary_color?: string | undefined;
|
package/package.json
CHANGED
|
@@ -120,6 +120,11 @@ export const customization_profile = z.object({
|
|
|
120
120
|
'Key of the customer that owns the profile, or `null` for a workspace-level profile. A customer can own a profile without using it; the profile a customer uses is `customization_profile_id` on the customer.',
|
|
121
121
|
),
|
|
122
122
|
created_at: datetime,
|
|
123
|
+
is_workspace_default: z
|
|
124
|
+
.boolean()
|
|
125
|
+
.describe(
|
|
126
|
+
"Whether this is the workspace's default profile, used for access grants and Instant Keys created without a customization profile.",
|
|
127
|
+
),
|
|
123
128
|
logo_url: z.string().url().optional(),
|
|
124
129
|
primary_color: z.string().optional(),
|
|
125
130
|
secondary_color: z.string().optional(),
|
|
@@ -14918,6 +14918,11 @@ const openapi: OpenAPISpec = {
|
|
|
14918
14918
|
},
|
|
14919
14919
|
type: 'object',
|
|
14920
14920
|
},
|
|
14921
|
+
is_workspace_default: {
|
|
14922
|
+
description:
|
|
14923
|
+
"Whether this is the workspace's default profile, used for access grants and Instant Keys created without a customization profile.",
|
|
14924
|
+
type: 'boolean',
|
|
14925
|
+
},
|
|
14921
14926
|
logo_url: { format: 'uri', type: 'string' },
|
|
14922
14927
|
message_overrides: {
|
|
14923
14928
|
additionalProperties: {
|
|
@@ -14937,6 +14942,7 @@ const openapi: OpenAPISpec = {
|
|
|
14937
14942
|
'customization_profile_id',
|
|
14938
14943
|
'customer_key',
|
|
14939
14944
|
'created_at',
|
|
14945
|
+
'is_workspace_default',
|
|
14940
14946
|
],
|
|
14941
14947
|
type: 'object',
|
|
14942
14948
|
'x-route-path': '/workspaces/customization_profiles',
|
|
@@ -63570,6 +63576,94 @@ const openapi: OpenAPISpec = {
|
|
|
63570
63576
|
'x-undocumented': 'Internal endpoint for customer portals.',
|
|
63571
63577
|
},
|
|
63572
63578
|
},
|
|
63579
|
+
'/seam/customer/v1/automations/get_guest_phone_last4_usage': {
|
|
63580
|
+
get: {
|
|
63581
|
+
description:
|
|
63582
|
+
'Lists the automations in the workspace, workspace-level and per-customer, that still use the deprecated prefer_guest_phone_last4_as_code setting.',
|
|
63583
|
+
operationId: 'seamCustomerV1AutomationsGetGuestPhoneLast4UsageGet',
|
|
63584
|
+
parameters: [],
|
|
63585
|
+
responses: {
|
|
63586
|
+
'200': {
|
|
63587
|
+
content: {
|
|
63588
|
+
'application/json': {
|
|
63589
|
+
schema: {
|
|
63590
|
+
properties: {
|
|
63591
|
+
customer_count: {
|
|
63592
|
+
description:
|
|
63593
|
+
'Number of customers whose automation uses prefer_guest_phone_last4_as_code.',
|
|
63594
|
+
type: 'integer',
|
|
63595
|
+
},
|
|
63596
|
+
is_used_by_workspace: {
|
|
63597
|
+
description:
|
|
63598
|
+
'Whether the workspace-level automation uses prefer_guest_phone_last4_as_code.',
|
|
63599
|
+
type: 'boolean',
|
|
63600
|
+
},
|
|
63601
|
+
ok: { type: 'boolean' },
|
|
63602
|
+
},
|
|
63603
|
+
required: ['is_used_by_workspace', 'customer_count', 'ok'],
|
|
63604
|
+
type: 'object',
|
|
63605
|
+
},
|
|
63606
|
+
},
|
|
63607
|
+
},
|
|
63608
|
+
description: 'OK',
|
|
63609
|
+
},
|
|
63610
|
+
'400': { description: 'Bad Request' },
|
|
63611
|
+
'401': { description: 'Unauthorized' },
|
|
63612
|
+
},
|
|
63613
|
+
security: [{ console_session_with_workspace: [] }, { api_key: [] }],
|
|
63614
|
+
summary: '/seam/customer/v1/automations/get_guest_phone_last4_usage',
|
|
63615
|
+
tags: [],
|
|
63616
|
+
'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'automations'],
|
|
63617
|
+
'x-fern-sdk-method-name': 'get_guest_phone_last4_usage',
|
|
63618
|
+
'x-response-key': null,
|
|
63619
|
+
'x-title': 'Get Guest Phone Last 4 Usage',
|
|
63620
|
+
'x-undocumented': 'Internal endpoint for the console.',
|
|
63621
|
+
},
|
|
63622
|
+
},
|
|
63623
|
+
'/seam/customer/v1/automations/switch_to_guest_phone_last_digits': {
|
|
63624
|
+
post: {
|
|
63625
|
+
description:
|
|
63626
|
+
'Switches every automation in the workspace, workspace-level and per-customer, from the deprecated prefer_guest_phone_last4_as_code setting to prefer_guest_phone_last_digits_as_code.',
|
|
63627
|
+
operationId:
|
|
63628
|
+
'seamCustomerV1AutomationsSwitchToGuestPhoneLastDigitsPost',
|
|
63629
|
+
requestBody: {
|
|
63630
|
+
content: {
|
|
63631
|
+
'application/json': { schema: { properties: {}, type: 'object' } },
|
|
63632
|
+
},
|
|
63633
|
+
},
|
|
63634
|
+
responses: {
|
|
63635
|
+
'200': {
|
|
63636
|
+
content: {
|
|
63637
|
+
'application/json': {
|
|
63638
|
+
schema: {
|
|
63639
|
+
properties: {
|
|
63640
|
+
ok: { type: 'boolean' },
|
|
63641
|
+
switched_count: {
|
|
63642
|
+
description: 'Number of automations that were switched.',
|
|
63643
|
+
type: 'integer',
|
|
63644
|
+
},
|
|
63645
|
+
},
|
|
63646
|
+
required: ['switched_count', 'ok'],
|
|
63647
|
+
type: 'object',
|
|
63648
|
+
},
|
|
63649
|
+
},
|
|
63650
|
+
},
|
|
63651
|
+
description: 'OK',
|
|
63652
|
+
},
|
|
63653
|
+
'400': { description: 'Bad Request' },
|
|
63654
|
+
'401': { description: 'Unauthorized' },
|
|
63655
|
+
},
|
|
63656
|
+
security: [{ console_session_with_workspace: [] }, { api_key: [] }],
|
|
63657
|
+
summary:
|
|
63658
|
+
'/seam/customer/v1/automations/switch_to_guest_phone_last_digits',
|
|
63659
|
+
tags: [],
|
|
63660
|
+
'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'automations'],
|
|
63661
|
+
'x-fern-sdk-method-name': 'switch_to_guest_phone_last_digits',
|
|
63662
|
+
'x-response-key': null,
|
|
63663
|
+
'x-title': 'Switch to Guest Phone Last Digits',
|
|
63664
|
+
'x-undocumented': 'Internal endpoint for the console.',
|
|
63665
|
+
},
|
|
63666
|
+
},
|
|
63573
63667
|
'/seam/customer/v1/automations/update': {
|
|
63574
63668
|
patch: {
|
|
63575
63669
|
description:
|
|
@@ -76284,7 +76378,7 @@ const openapi: OpenAPISpec = {
|
|
|
76284
76378
|
'/workspaces/customization_profiles/create': {
|
|
76285
76379
|
post: {
|
|
76286
76380
|
description:
|
|
76287
|
-
"Creates a customization profile. From a customer client session, the profile is owned by that customer, and it becomes the customer's `customization_profile_id` when the customer has none yet.",
|
|
76381
|
+
"Creates a customization profile. From a customer client session, the profile is owned by that customer, and it becomes the customer's `customization_profile_id` when the customer has none yet. A workspace's first workspace-level profile becomes its default (`is_workspace_default`).",
|
|
76288
76382
|
operationId: 'workspacesCustomizationProfilesCreatePost',
|
|
76289
76383
|
requestBody: {
|
|
76290
76384
|
content: {
|
|
@@ -76776,7 +76870,8 @@ const openapi: OpenAPISpec = {
|
|
|
76776
76870
|
},
|
|
76777
76871
|
'/workspaces/customization_profiles/update': {
|
|
76778
76872
|
patch: {
|
|
76779
|
-
description:
|
|
76873
|
+
description:
|
|
76874
|
+
"Updates the customization profile for the workspace.\n\n`is_workspace_default: true` makes a workspace-level profile the workspace's default, replacing the previous one: access grants and Instant Keys created without a customization profile use it. `false` removes it, so they use the Seam default again. A customer client session can't change the default.",
|
|
76780
76875
|
operationId: 'workspacesCustomizationProfilesUpdatePatch',
|
|
76781
76876
|
requestBody: {
|
|
76782
76877
|
content: {
|
|
@@ -77108,6 +77203,7 @@ const openapi: OpenAPISpec = {
|
|
|
77108
77203
|
},
|
|
77109
77204
|
type: 'object',
|
|
77110
77205
|
},
|
|
77206
|
+
is_workspace_default: { type: 'boolean' },
|
|
77111
77207
|
message_overrides: {
|
|
77112
77208
|
additionalProperties: {
|
|
77113
77209
|
additionalProperties: { type: 'string' },
|
|
@@ -105620,6 +105620,8 @@ export type Routes = {
|
|
|
105620
105620
|
/** Key of the customer that owns the profile, or `null` for a workspace-level profile. A customer can own a profile without using it; the profile a customer uses is `customization_profile_id` on the customer. */
|
|
105621
105621
|
customer_key: string | null
|
|
105622
105622
|
created_at: string
|
|
105623
|
+
/** Whether this is the workspace's default profile, used for access grants and Instant Keys created without a customization profile. */
|
|
105624
|
+
is_workspace_default: boolean
|
|
105623
105625
|
logo_url?: string | undefined
|
|
105624
105626
|
primary_color?: string | undefined
|
|
105625
105627
|
secondary_color?: string | undefined
|
|
@@ -109540,6 +109542,34 @@ export type Routes = {
|
|
|
109540
109542
|
}
|
|
109541
109543
|
maxDuration: undefined
|
|
109542
109544
|
}
|
|
109545
|
+
'/seam/customer/v1/automations/get_guest_phone_last4_usage': {
|
|
109546
|
+
route: '/seam/customer/v1/automations/get_guest_phone_last4_usage'
|
|
109547
|
+
method: 'GET' | 'POST'
|
|
109548
|
+
queryParams: {}
|
|
109549
|
+
jsonBody: {}
|
|
109550
|
+
commonParams: {}
|
|
109551
|
+
formData: {}
|
|
109552
|
+
jsonResponse: {
|
|
109553
|
+
/** Whether the workspace-level automation uses prefer_guest_phone_last4_as_code. */
|
|
109554
|
+
is_used_by_workspace: boolean
|
|
109555
|
+
/** Number of customers whose automation uses prefer_guest_phone_last4_as_code. */
|
|
109556
|
+
customer_count: number
|
|
109557
|
+
}
|
|
109558
|
+
maxDuration: undefined
|
|
109559
|
+
}
|
|
109560
|
+
'/seam/customer/v1/automations/switch_to_guest_phone_last_digits': {
|
|
109561
|
+
route: '/seam/customer/v1/automations/switch_to_guest_phone_last_digits'
|
|
109562
|
+
method: 'POST'
|
|
109563
|
+
queryParams: {}
|
|
109564
|
+
jsonBody: {}
|
|
109565
|
+
commonParams: {}
|
|
109566
|
+
formData: {}
|
|
109567
|
+
jsonResponse: {
|
|
109568
|
+
/** Number of automations that were switched. */
|
|
109569
|
+
switched_count: number
|
|
109570
|
+
}
|
|
109571
|
+
maxDuration: undefined
|
|
109572
|
+
}
|
|
109543
109573
|
'/seam/customer/v1/automations/update': {
|
|
109544
109574
|
route: '/seam/customer/v1/automations/update'
|
|
109545
109575
|
method: 'PATCH' | 'POST'
|
|
@@ -176651,6 +176681,8 @@ export type Routes = {
|
|
|
176651
176681
|
/** Key of the customer that owns the profile, or `null` for a workspace-level profile. A customer can own a profile without using it; the profile a customer uses is `customization_profile_id` on the customer. */
|
|
176652
176682
|
customer_key: string | null
|
|
176653
176683
|
created_at: string
|
|
176684
|
+
/** Whether this is the workspace's default profile, used for access grants and Instant Keys created without a customization profile. */
|
|
176685
|
+
is_workspace_default: boolean
|
|
176654
176686
|
logo_url?: string | undefined
|
|
176655
176687
|
primary_color?: string | undefined
|
|
176656
176688
|
secondary_color?: string | undefined
|
|
@@ -176822,6 +176854,8 @@ export type Routes = {
|
|
|
176822
176854
|
/** Key of the customer that owns the profile, or `null` for a workspace-level profile. A customer can own a profile without using it; the profile a customer uses is `customization_profile_id` on the customer. */
|
|
176823
176855
|
customer_key: string | null
|
|
176824
176856
|
created_at: string
|
|
176857
|
+
/** Whether this is the workspace's default profile, used for access grants and Instant Keys created without a customization profile. */
|
|
176858
|
+
is_workspace_default: boolean
|
|
176825
176859
|
logo_url?: string | undefined
|
|
176826
176860
|
primary_color?: string | undefined
|
|
176827
176861
|
secondary_color?: string | undefined
|
|
@@ -176993,6 +177027,8 @@ export type Routes = {
|
|
|
176993
177027
|
/** Key of the customer that owns the profile, or `null` for a workspace-level profile. A customer can own a profile without using it; the profile a customer uses is `customization_profile_id` on the customer. */
|
|
176994
177028
|
customer_key: string | null
|
|
176995
177029
|
created_at: string
|
|
177030
|
+
/** Whether this is the workspace's default profile, used for access grants and Instant Keys created without a customization profile. */
|
|
177031
|
+
is_workspace_default: boolean
|
|
176996
177032
|
logo_url?: string | undefined
|
|
176997
177033
|
primary_color?: string | undefined
|
|
176998
177034
|
secondary_color?: string | undefined
|
|
@@ -177309,6 +177345,7 @@ export type Routes = {
|
|
|
177309
177345
|
| undefined
|
|
177310
177346
|
)
|
|
177311
177347
|
| null
|
|
177348
|
+
is_workspace_default?: boolean | undefined
|
|
177312
177349
|
}
|
|
177313
177350
|
commonParams: {}
|
|
177314
177351
|
formData: {}
|
|
@@ -190453,6 +190490,8 @@ export type Routes = {
|
|
|
190453
190490
|
/** Key of the customer that owns the profile, or `null` for a workspace-level profile. A customer can own a profile without using it; the profile a customer uses is `customization_profile_id` on the customer. */
|
|
190454
190491
|
customer_key: string | null
|
|
190455
190492
|
created_at: string
|
|
190493
|
+
/** Whether this is the workspace's default profile, used for access grants and Instant Keys created without a customization profile. */
|
|
190494
|
+
is_workspace_default: boolean
|
|
190456
190495
|
logo_url?: string | undefined
|
|
190457
190496
|
primary_color?: string | undefined
|
|
190458
190497
|
secondary_color?: string | undefined
|