@seamapi/types 1.1093.0 → 1.1094.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. */
@@ -84624,6 +84628,34 @@ export type Routes = {
84624
84628
  jsonResponse: {};
84625
84629
  maxDuration: undefined;
84626
84630
  };
84631
+ '/seam/customer/v1/customers/get': {
84632
+ route: '/seam/customer/v1/customers/get';
84633
+ method: 'GET' | 'POST';
84634
+ queryParams: {};
84635
+ jsonBody: {};
84636
+ commonParams: {
84637
+ /** Key of the customer that you want to get. */
84638
+ customer_key: string;
84639
+ } | {
84640
+ /** ID of the customer that you want to get. */
84641
+ customer_id: string;
84642
+ };
84643
+ formData: {};
84644
+ jsonResponse: {
84645
+ /** 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. */
84646
+ customer: {
84647
+ /** Unique key for the customer within the workspace. */
84648
+ customer_key: string;
84649
+ /** ID of the workspace associated with the customer. */
84650
+ workspace_id: string;
84651
+ /** Date and time at which the customer was created. */
84652
+ created_at: string;
84653
+ /** ID of the customization profile associated with the customer. Access grants that automations create for this customer use this profile. */
84654
+ customization_profile_id: string | null;
84655
+ };
84656
+ };
84657
+ maxDuration: undefined;
84658
+ };
84627
84659
  '/seam/customer/v1/customers/list': {
84628
84660
  route: '/seam/customer/v1/customers/list';
84629
84661
  method: 'GET' | 'POST';
@@ -84646,6 +84678,8 @@ export type Routes = {
84646
84678
  workspace_id: string;
84647
84679
  /** Date and time at which the customer was created. */
84648
84680
  created_at: string;
84681
+ /** ID of the customization profile associated with the customer. Access grants that automations create for this customer use this profile. */
84682
+ customization_profile_id: string | null;
84649
84683
  }[];
84650
84684
  /** Information about the current page of results. */
84651
84685
  pagination: {
@@ -84669,6 +84703,7 @@ export type Routes = {
84669
84703
  jsonResponse: {
84670
84704
  customer: {
84671
84705
  customer_key: string;
84706
+ customization_profile_id: string | null;
84672
84707
  };
84673
84708
  connector?: {
84674
84709
  connector_type: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.1093.0",
3
+ "version": "1.1094.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
@@ -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.',
@@ -49018,6 +49030,13 @@ const openapi: OpenAPISpec = {
49018
49030
  minLength: 1,
49019
49031
  type: 'string',
49020
49032
  },
49033
+ customization_profile_id: {
49034
+ description:
49035
+ "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.",
49036
+ format: 'uuid',
49037
+ nullable: true,
49038
+ type: 'string',
49039
+ },
49021
49040
  facilities: {
49022
49041
  description: 'List of gym or fitness facilities.',
49023
49042
  items: {
@@ -50196,6 +50215,13 @@ const openapi: OpenAPISpec = {
50196
50215
  minLength: 1,
50197
50216
  type: 'string',
50198
50217
  },
50218
+ customization_profile_id: {
50219
+ description:
50220
+ "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.",
50221
+ format: 'uuid',
50222
+ nullable: true,
50223
+ type: 'string',
50224
+ },
50199
50225
  facilities: {
50200
50226
  description: 'List of gym or fitness facilities.',
50201
50227
  items: {
@@ -62050,6 +62076,65 @@ const openapi: OpenAPISpec = {
62050
62076
  'x-undocumented': 'Internal endpoint for customer portals.',
62051
62077
  },
62052
62078
  },
62079
+ '/seam/customer/v1/customers/get': {
62080
+ get: {
62081
+ description: 'Returns a specified customer.',
62082
+ operationId: 'seamCustomerV1CustomersGetGet',
62083
+ parameters: [
62084
+ {
62085
+ in: 'query',
62086
+ name: 'customer_key',
62087
+ schema: {
62088
+ description: 'Key of the customer that you want to get.',
62089
+ minLength: 1,
62090
+ type: 'string',
62091
+ },
62092
+ },
62093
+ {
62094
+ in: 'query',
62095
+ name: 'customer_id',
62096
+ schema: {
62097
+ description: 'ID of the customer that you want to get.',
62098
+ format: 'uuid',
62099
+ type: 'string',
62100
+ },
62101
+ },
62102
+ ],
62103
+ responses: {
62104
+ '200': {
62105
+ content: {
62106
+ 'application/json': {
62107
+ schema: {
62108
+ properties: {
62109
+ customer: { $ref: '#/components/schemas/customer' },
62110
+ ok: { type: 'boolean' },
62111
+ },
62112
+ required: ['customer', 'ok'],
62113
+ type: 'object',
62114
+ },
62115
+ },
62116
+ },
62117
+ description: 'OK',
62118
+ },
62119
+ '400': { description: 'Bad Request' },
62120
+ '401': { description: 'Unauthorized' },
62121
+ },
62122
+ security: [
62123
+ { api_key: [] },
62124
+ { pat_with_workspace: [] },
62125
+ { console_session_with_workspace: [] },
62126
+ ],
62127
+ summary: '/seam/customer/v1/customers/get',
62128
+ tags: [],
62129
+ 'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'customers'],
62130
+ 'x-fern-sdk-method-name': 'get',
62131
+ 'x-fern-sdk-return-value': 'customer',
62132
+ 'x-has-required-parameters': true,
62133
+ 'x-response-key': 'customer',
62134
+ 'x-title': 'Get a Customer',
62135
+ 'x-undocumented': 'Internal endpoint for Console.',
62136
+ },
62137
+ },
62053
62138
  '/seam/customer/v1/customers/list': {
62054
62139
  get: {
62055
62140
  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
  | {
@@ -101617,6 +101621,36 @@ export type Routes = {
101617
101621
  jsonResponse: {}
101618
101622
  maxDuration: undefined
101619
101623
  }
101624
+ '/seam/customer/v1/customers/get': {
101625
+ route: '/seam/customer/v1/customers/get'
101626
+ method: 'GET' | 'POST'
101627
+ queryParams: {}
101628
+ jsonBody: {}
101629
+ commonParams:
101630
+ | {
101631
+ /** Key of the customer that you want to get. */
101632
+ customer_key: string
101633
+ }
101634
+ | {
101635
+ /** ID of the customer that you want to get. */
101636
+ customer_id: string
101637
+ }
101638
+ formData: {}
101639
+ jsonResponse: {
101640
+ /** 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. */
101641
+ customer: {
101642
+ /** Unique key for the customer within the workspace. */
101643
+ customer_key: string
101644
+ /** ID of the workspace associated with the customer. */
101645
+ workspace_id: string
101646
+ /** Date and time at which the customer was created. */
101647
+ created_at: string
101648
+ /** ID of the customization profile associated with the customer. Access grants that automations create for this customer use this profile. */
101649
+ customization_profile_id: string | null
101650
+ }
101651
+ }
101652
+ maxDuration: undefined
101653
+ }
101620
101654
  '/seam/customer/v1/customers/list': {
101621
101655
  route: '/seam/customer/v1/customers/list'
101622
101656
  method: 'GET' | 'POST'
@@ -101639,6 +101673,8 @@ export type Routes = {
101639
101673
  workspace_id: string
101640
101674
  /** Date and time at which the customer was created. */
101641
101675
  created_at: string
101676
+ /** ID of the customization profile associated with the customer. Access grants that automations create for this customer use this profile. */
101677
+ customization_profile_id: string | null
101642
101678
  }[]
101643
101679
  /** Information about the current page of results. */
101644
101680
  pagination: {
@@ -101662,6 +101698,7 @@ export type Routes = {
101662
101698
  jsonResponse: {
101663
101699
  customer: {
101664
101700
  customer_key: string
101701
+ customization_profile_id: string | null
101665
101702
  }
101666
101703
  connector?:
101667
101704
  | {