@seamapi/types 1.1093.0 → 1.1095.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.
@@ -43384,6 +43384,8 @@ export type Routes = {
43384
43384
  customer_data?: {
43385
43385
  /** Your unique identifier for the customer. */
43386
43386
  customer_key: string;
43387
+ /** ID of the customization profile to use for this customer. Access grants that automations create for this customer use this profile. Pass `null` to remove the customer's customization profile. */
43388
+ customization_profile_id?: (string | null) | undefined;
43387
43389
  /** List of general spaces or areas. */
43388
43390
  spaces?: {
43389
43391
  /** Your display name for this location resource. */
@@ -43791,6 +43793,8 @@ export type Routes = {
43791
43793
  jsonBody: {
43792
43794
  /** Your unique identifier for the customer. */
43793
43795
  customer_key: string;
43796
+ /** ID of the customization profile to use for this customer. Access grants that automations create for this customer use this profile. Pass `null` to remove the customer's customization profile. */
43797
+ customization_profile_id?: (string | null) | undefined;
43794
43798
  /** List of general spaces or areas. */
43795
43799
  spaces?: {
43796
43800
  /** Your display name for this location resource. */
@@ -81031,6 +81035,8 @@ export type Routes = {
81031
81035
  workspace_id: string;
81032
81036
  name: string | null;
81033
81037
  customization_profile_id: string;
81038
+ /** 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. */
81039
+ customer_key: string | null;
81034
81040
  created_at: string;
81035
81041
  logo_url?: string | undefined;
81036
81042
  primary_color?: string | undefined;
@@ -84624,6 +84630,34 @@ export type Routes = {
84624
84630
  jsonResponse: {};
84625
84631
  maxDuration: undefined;
84626
84632
  };
84633
+ '/seam/customer/v1/customers/get': {
84634
+ route: '/seam/customer/v1/customers/get';
84635
+ method: 'GET' | 'POST';
84636
+ queryParams: {};
84637
+ jsonBody: {};
84638
+ commonParams: {
84639
+ /** Key of the customer that you want to get. */
84640
+ customer_key: string;
84641
+ } | {
84642
+ /** ID of the customer that you want to get. */
84643
+ customer_id: string;
84644
+ };
84645
+ formData: {};
84646
+ jsonResponse: {
84647
+ /** Represents a customer within a workspace. Customers are used to organize resources and manage access for different clients, such as hotels, property managers, and more. */
84648
+ customer: {
84649
+ /** Unique key for the customer within the workspace. */
84650
+ customer_key: string;
84651
+ /** ID of the workspace associated with the customer. */
84652
+ workspace_id: string;
84653
+ /** Date and time at which the customer was created. */
84654
+ created_at: string;
84655
+ /** ID of the customization profile associated with the customer. Access grants that automations create for this customer use this profile. */
84656
+ customization_profile_id: string | null;
84657
+ };
84658
+ };
84659
+ maxDuration: undefined;
84660
+ };
84627
84661
  '/seam/customer/v1/customers/list': {
84628
84662
  route: '/seam/customer/v1/customers/list';
84629
84663
  method: 'GET' | 'POST';
@@ -84646,6 +84680,8 @@ export type Routes = {
84646
84680
  workspace_id: string;
84647
84681
  /** Date and time at which the customer was created. */
84648
84682
  created_at: string;
84683
+ /** ID of the customization profile associated with the customer. Access grants that automations create for this customer use this profile. */
84684
+ customization_profile_id: string | null;
84649
84685
  }[];
84650
84686
  /** Information about the current page of results. */
84651
84687
  pagination: {
@@ -84669,6 +84705,7 @@ export type Routes = {
84669
84705
  jsonResponse: {
84670
84706
  customer: {
84671
84707
  customer_key: string;
84708
+ customization_profile_id: string | null;
84672
84709
  };
84673
84710
  connector?: {
84674
84711
  connector_type: string;
@@ -125172,6 +125209,8 @@ export type Routes = {
125172
125209
  workspace_id: string;
125173
125210
  name: string | null;
125174
125211
  customization_profile_id: string;
125212
+ /** 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. */
125213
+ customer_key: string | null;
125175
125214
  created_at: string;
125176
125215
  logo_url?: string | undefined;
125177
125216
  primary_color?: string | undefined;
@@ -125208,6 +125247,8 @@ export type Routes = {
125208
125247
  workspace_id: string;
125209
125248
  name: string | null;
125210
125249
  customization_profile_id: string;
125250
+ /** 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. */
125251
+ customer_key: string | null;
125211
125252
  created_at: string;
125212
125253
  logo_url?: string | undefined;
125213
125254
  primary_color?: string | undefined;
@@ -125244,6 +125285,8 @@ export type Routes = {
125244
125285
  workspace_id: string;
125245
125286
  name: string | null;
125246
125287
  customization_profile_id: string;
125288
+ /** 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. */
125289
+ customer_key: string | null;
125247
125290
  created_at: string;
125248
125291
  logo_url?: string | undefined;
125249
125292
  primary_color?: string | undefined;
@@ -135982,6 +136025,8 @@ export type Routes = {
135982
136025
  workspace_id: string;
135983
136026
  name: string | null;
135984
136027
  customization_profile_id: string;
136028
+ /** 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. */
136029
+ customer_key: string | null;
135985
136030
  created_at: string;
135986
136031
  logo_url?: string | undefined;
135987
136032
  primary_color?: string | undefined;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.1093.0",
3
+ "version": "1.1095.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -106,6 +106,14 @@ export const customer_data = z
106
106
  message: 'Must not have leading or trailing whitespace',
107
107
  })
108
108
  .describe('Your unique identifier for the customer.'),
109
+ customization_profile_id: z
110
+ .string()
111
+ .uuid()
112
+ .nullable()
113
+ .optional()
114
+ .describe(
115
+ "ID of the customization profile to use for this customer. Access grants that automations create for this customer use this profile. Pass `null` to remove the customer's customization profile.",
116
+ ),
109
117
  })
110
118
  .merge(external_resources)
111
119
 
@@ -13,6 +13,13 @@ export const customer = z.object({
13
13
  created_at: datetime.describe(
14
14
  'Date and time at which the customer was created.',
15
15
  ),
16
+ customization_profile_id: z
17
+ .string()
18
+ .uuid()
19
+ .nullable()
20
+ .describe(
21
+ 'ID of the customization profile associated with the customer. Access grants that automations create for this customer use this profile.',
22
+ ),
16
23
  }).describe(`
17
24
  ---
18
25
  route_path: /customers
@@ -21,6 +21,12 @@ export const customization_profile = z.object({
21
21
  workspace_id: z.string().uuid(),
22
22
  name: z.string().nullable(),
23
23
  customization_profile_id: z.string().uuid(),
24
+ customer_key: z
25
+ .string()
26
+ .nullable()
27
+ .describe(
28
+ '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.',
29
+ ),
24
30
  created_at: datetime,
25
31
  logo_url: z.string().url().optional(),
26
32
  primary_color: z.string().optional(),
@@ -13560,13 +13560,25 @@ const openapi: OpenAPISpec = {
13560
13560
  description: 'Unique key for the customer within the workspace.',
13561
13561
  type: 'string',
13562
13562
  },
13563
+ customization_profile_id: {
13564
+ description:
13565
+ 'ID of the customization profile associated with the customer. Access grants that automations create for this customer use this profile.',
13566
+ format: 'uuid',
13567
+ nullable: true,
13568
+ type: 'string',
13569
+ },
13563
13570
  workspace_id: {
13564
13571
  description: 'ID of the workspace associated with the customer.',
13565
13572
  format: 'uuid',
13566
13573
  type: 'string',
13567
13574
  },
13568
13575
  },
13569
- required: ['customer_key', 'workspace_id', 'created_at'],
13576
+ required: [
13577
+ 'customer_key',
13578
+ 'workspace_id',
13579
+ 'created_at',
13580
+ 'customization_profile_id',
13581
+ ],
13570
13582
  type: 'object',
13571
13583
  'x-route-path': '/customers',
13572
13584
  'x-undocumented': 'Internal resource.',
@@ -13617,6 +13629,12 @@ const openapi: OpenAPISpec = {
13617
13629
  description: 'A customization profile.',
13618
13630
  properties: {
13619
13631
  created_at: { format: 'date-time', type: 'string' },
13632
+ customer_key: {
13633
+ description:
13634
+ '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.',
13635
+ nullable: true,
13636
+ type: 'string',
13637
+ },
13620
13638
  customer_portal_theme: {
13621
13639
  properties: {
13622
13640
  font_family: { type: 'string' },
@@ -13646,6 +13664,7 @@ const openapi: OpenAPISpec = {
13646
13664
  'workspace_id',
13647
13665
  'name',
13648
13666
  'customization_profile_id',
13667
+ 'customer_key',
13649
13668
  'created_at',
13650
13669
  ],
13651
13670
  type: 'object',
@@ -49018,6 +49037,13 @@ const openapi: OpenAPISpec = {
49018
49037
  minLength: 1,
49019
49038
  type: 'string',
49020
49039
  },
49040
+ customization_profile_id: {
49041
+ description:
49042
+ "ID of the customization profile to use for this customer. Access grants that automations create for this customer use this profile. Pass `null` to remove the customer's customization profile.",
49043
+ format: 'uuid',
49044
+ nullable: true,
49045
+ type: 'string',
49046
+ },
49021
49047
  facilities: {
49022
49048
  description: 'List of gym or fitness facilities.',
49023
49049
  items: {
@@ -50196,6 +50222,13 @@ const openapi: OpenAPISpec = {
50196
50222
  minLength: 1,
50197
50223
  type: 'string',
50198
50224
  },
50225
+ customization_profile_id: {
50226
+ description:
50227
+ "ID of the customization profile to use for this customer. Access grants that automations create for this customer use this profile. Pass `null` to remove the customer's customization profile.",
50228
+ format: 'uuid',
50229
+ nullable: true,
50230
+ type: 'string',
50231
+ },
50199
50232
  facilities: {
50200
50233
  description: 'List of gym or fitness facilities.',
50201
50234
  items: {
@@ -62050,6 +62083,65 @@ const openapi: OpenAPISpec = {
62050
62083
  'x-undocumented': 'Internal endpoint for customer portals.',
62051
62084
  },
62052
62085
  },
62086
+ '/seam/customer/v1/customers/get': {
62087
+ get: {
62088
+ description: 'Returns a specified customer.',
62089
+ operationId: 'seamCustomerV1CustomersGetGet',
62090
+ parameters: [
62091
+ {
62092
+ in: 'query',
62093
+ name: 'customer_key',
62094
+ schema: {
62095
+ description: 'Key of the customer that you want to get.',
62096
+ minLength: 1,
62097
+ type: 'string',
62098
+ },
62099
+ },
62100
+ {
62101
+ in: 'query',
62102
+ name: 'customer_id',
62103
+ schema: {
62104
+ description: 'ID of the customer that you want to get.',
62105
+ format: 'uuid',
62106
+ type: 'string',
62107
+ },
62108
+ },
62109
+ ],
62110
+ responses: {
62111
+ '200': {
62112
+ content: {
62113
+ 'application/json': {
62114
+ schema: {
62115
+ properties: {
62116
+ customer: { $ref: '#/components/schemas/customer' },
62117
+ ok: { type: 'boolean' },
62118
+ },
62119
+ required: ['customer', 'ok'],
62120
+ type: 'object',
62121
+ },
62122
+ },
62123
+ },
62124
+ description: 'OK',
62125
+ },
62126
+ '400': { description: 'Bad Request' },
62127
+ '401': { description: 'Unauthorized' },
62128
+ },
62129
+ security: [
62130
+ { api_key: [] },
62131
+ { pat_with_workspace: [] },
62132
+ { console_session_with_workspace: [] },
62133
+ ],
62134
+ summary: '/seam/customer/v1/customers/get',
62135
+ tags: [],
62136
+ 'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'customers'],
62137
+ 'x-fern-sdk-method-name': 'get',
62138
+ 'x-fern-sdk-return-value': 'customer',
62139
+ 'x-has-required-parameters': true,
62140
+ 'x-response-key': 'customer',
62141
+ 'x-title': 'Get a Customer',
62142
+ 'x-undocumented': 'Internal endpoint for Console.',
62143
+ },
62144
+ },
62053
62145
  '/seam/customer/v1/customers/list': {
62054
62146
  get: {
62055
62147
  description: 'Returns a list of all customers within the workspace.',
@@ -50856,6 +50856,8 @@ export type Routes = {
50856
50856
  | {
50857
50857
  /** Your unique identifier for the customer. */
50858
50858
  customer_key: string
50859
+ /** ID of the customization profile to use for this customer. Access grants that automations create for this customer use this profile. Pass `null` to remove the customer's customization profile. */
50860
+ customization_profile_id?: (string | null) | undefined
50859
50861
  /** List of general spaces or areas. */
50860
50862
  spaces?:
50861
50863
  | {
@@ -51310,6 +51312,8 @@ export type Routes = {
51310
51312
  jsonBody: {
51311
51313
  /** Your unique identifier for the customer. */
51312
51314
  customer_key: string
51315
+ /** ID of the customization profile to use for this customer. Access grants that automations create for this customer use this profile. Pass `null` to remove the customer's customization profile. */
51316
+ customization_profile_id?: (string | null) | undefined
51313
51317
  /** List of general spaces or areas. */
51314
51318
  spaces?:
51315
51319
  | {
@@ -97479,6 +97483,8 @@ export type Routes = {
97479
97483
  workspace_id: string
97480
97484
  name: string | null
97481
97485
  customization_profile_id: string
97486
+ /** 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. */
97487
+ customer_key: string | null
97482
97488
  created_at: string
97483
97489
  logo_url?: string | undefined
97484
97490
  primary_color?: string | undefined
@@ -101617,6 +101623,36 @@ export type Routes = {
101617
101623
  jsonResponse: {}
101618
101624
  maxDuration: undefined
101619
101625
  }
101626
+ '/seam/customer/v1/customers/get': {
101627
+ route: '/seam/customer/v1/customers/get'
101628
+ method: 'GET' | 'POST'
101629
+ queryParams: {}
101630
+ jsonBody: {}
101631
+ commonParams:
101632
+ | {
101633
+ /** Key of the customer that you want to get. */
101634
+ customer_key: string
101635
+ }
101636
+ | {
101637
+ /** ID of the customer that you want to get. */
101638
+ customer_id: string
101639
+ }
101640
+ formData: {}
101641
+ jsonResponse: {
101642
+ /** Represents a customer within a workspace. Customers are used to organize resources and manage access for different clients, such as hotels, property managers, and more. */
101643
+ customer: {
101644
+ /** Unique key for the customer within the workspace. */
101645
+ customer_key: string
101646
+ /** ID of the workspace associated with the customer. */
101647
+ workspace_id: string
101648
+ /** Date and time at which the customer was created. */
101649
+ created_at: string
101650
+ /** ID of the customization profile associated with the customer. Access grants that automations create for this customer use this profile. */
101651
+ customization_profile_id: string | null
101652
+ }
101653
+ }
101654
+ maxDuration: undefined
101655
+ }
101620
101656
  '/seam/customer/v1/customers/list': {
101621
101657
  route: '/seam/customer/v1/customers/list'
101622
101658
  method: 'GET' | 'POST'
@@ -101639,6 +101675,8 @@ export type Routes = {
101639
101675
  workspace_id: string
101640
101676
  /** Date and time at which the customer was created. */
101641
101677
  created_at: string
101678
+ /** ID of the customization profile associated with the customer. Access grants that automations create for this customer use this profile. */
101679
+ customization_profile_id: string | null
101642
101680
  }[]
101643
101681
  /** Information about the current page of results. */
101644
101682
  pagination: {
@@ -101662,6 +101700,7 @@ export type Routes = {
101662
101700
  jsonResponse: {
101663
101701
  customer: {
101664
101702
  customer_key: string
101703
+ customization_profile_id: string | null
101665
101704
  }
101666
101705
  connector?:
101667
101706
  | {
@@ -149792,6 +149831,8 @@ export type Routes = {
149792
149831
  workspace_id: string
149793
149832
  name: string | null
149794
149833
  customization_profile_id: string
149834
+ /** 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. */
149835
+ customer_key: string | null
149795
149836
  created_at: string
149796
149837
  logo_url?: string | undefined
149797
149838
  primary_color?: string | undefined
@@ -149832,6 +149873,8 @@ export type Routes = {
149832
149873
  workspace_id: string
149833
149874
  name: string | null
149834
149875
  customization_profile_id: string
149876
+ /** 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. */
149877
+ customer_key: string | null
149835
149878
  created_at: string
149836
149879
  logo_url?: string | undefined
149837
149880
  primary_color?: string | undefined
@@ -149872,6 +149915,8 @@ export type Routes = {
149872
149915
  workspace_id: string
149873
149916
  name: string | null
149874
149917
  customization_profile_id: string
149918
+ /** 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. */
149919
+ customer_key: string | null
149875
149920
  created_at: string
149876
149921
  logo_url?: string | undefined
149877
149922
  primary_color?: string | undefined
@@ -162533,6 +162578,8 @@ export type Routes = {
162533
162578
  workspace_id: string
162534
162579
  name: string | null
162535
162580
  customization_profile_id: string
162581
+ /** 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. */
162582
+ customer_key: string | null
162536
162583
  created_at: string
162537
162584
  logo_url?: string | undefined
162538
162585
  primary_color?: string | undefined