@seamapi/types 1.1092.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.
@@ -11984,13 +11984,24 @@ const openapi = {
11984
11984
  description: 'Unique key for the customer within the workspace.',
11985
11985
  type: 'string',
11986
11986
  },
11987
+ customization_profile_id: {
11988
+ description: 'ID of the customization profile associated with the customer. Access grants that automations create for this customer use this profile.',
11989
+ format: 'uuid',
11990
+ nullable: true,
11991
+ type: 'string',
11992
+ },
11987
11993
  workspace_id: {
11988
11994
  description: 'ID of the workspace associated with the customer.',
11989
11995
  format: 'uuid',
11990
11996
  type: 'string',
11991
11997
  },
11992
11998
  },
11993
- required: ['customer_key', 'workspace_id', 'created_at'],
11999
+ required: [
12000
+ 'customer_key',
12001
+ 'workspace_id',
12002
+ 'created_at',
12003
+ 'customization_profile_id',
12004
+ ],
11994
12005
  type: 'object',
11995
12006
  'x-route-path': '/customers',
11996
12007
  'x-undocumented': 'Internal resource.',
@@ -44083,7 +44094,8 @@ const openapi = {
44083
44094
  type: 'string',
44084
44095
  },
44085
44096
  preferred_code: {
44086
- description: 'Preferred PIN code to use when creating access for this reservation.',
44097
+ description: 'Preferred PIN code to use when creating access for this reservation. Set to `null` to remove a previously set preferred code, so that access falls back to an automatically generated code. Omitting this field keeps any previously set preferred code.',
44098
+ nullable: true,
44087
44099
  type: 'string',
44088
44100
  },
44089
44101
  property_keys: {
@@ -44176,7 +44188,8 @@ const openapi = {
44176
44188
  type: 'string',
44177
44189
  },
44178
44190
  preferred_code: {
44179
- description: 'Preferred PIN code to use when creating access for this reservation.',
44191
+ description: 'Preferred PIN code to use when creating access for this reservation. Set to `null` to remove a previously set preferred code, so that access falls back to an automatically generated code. Omitting this field keeps any previously set preferred code.',
44192
+ nullable: true,
44180
44193
  type: 'string',
44181
44194
  },
44182
44195
  property_keys: {
@@ -44274,6 +44287,12 @@ const openapi = {
44274
44287
  minLength: 1,
44275
44288
  type: 'string',
44276
44289
  },
44290
+ customization_profile_id: {
44291
+ description: "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.",
44292
+ format: 'uuid',
44293
+ nullable: true,
44294
+ type: 'string',
44295
+ },
44277
44296
  facilities: {
44278
44297
  description: 'List of gym or fitness facilities.',
44279
44298
  items: {
@@ -44437,7 +44456,8 @@ const openapi = {
44437
44456
  type: 'string',
44438
44457
  },
44439
44458
  preferred_code: {
44440
- description: 'Preferred PIN code to use when creating access for this reservation.',
44459
+ description: 'Preferred PIN code to use when creating access for this reservation. Set to `null` to remove a previously set preferred code, so that access falls back to an automatically generated code. Omitting this field keeps any previously set preferred code.',
44460
+ nullable: true,
44441
44461
  type: 'string',
44442
44462
  },
44443
44463
  property_keys: {
@@ -45128,7 +45148,8 @@ const openapi = {
45128
45148
  type: 'string',
45129
45149
  },
45130
45150
  preferred_code: {
45131
- description: 'Preferred PIN code to use when creating access for this reservation.',
45151
+ description: 'Preferred PIN code to use when creating access for this reservation. Set to `null` to remove a previously set preferred code, so that access falls back to an automatically generated code. Omitting this field keeps any previously set preferred code.',
45152
+ nullable: true,
45132
45153
  type: 'string',
45133
45154
  },
45134
45155
  property_keys: {
@@ -45221,7 +45242,8 @@ const openapi = {
45221
45242
  type: 'string',
45222
45243
  },
45223
45244
  preferred_code: {
45224
- description: 'Preferred PIN code to use when creating access for this reservation.',
45245
+ description: 'Preferred PIN code to use when creating access for this reservation. Set to `null` to remove a previously set preferred code, so that access falls back to an automatically generated code. Omitting this field keeps any previously set preferred code.',
45246
+ nullable: true,
45225
45247
  type: 'string',
45226
45248
  },
45227
45249
  property_keys: {
@@ -45319,6 +45341,12 @@ const openapi = {
45319
45341
  minLength: 1,
45320
45342
  type: 'string',
45321
45343
  },
45344
+ customization_profile_id: {
45345
+ description: "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.",
45346
+ format: 'uuid',
45347
+ nullable: true,
45348
+ type: 'string',
45349
+ },
45322
45350
  facilities: {
45323
45351
  description: 'List of gym or fitness facilities.',
45324
45352
  items: {
@@ -45482,7 +45510,8 @@ const openapi = {
45482
45510
  type: 'string',
45483
45511
  },
45484
45512
  preferred_code: {
45485
- description: 'Preferred PIN code to use when creating access for this reservation.',
45513
+ description: 'Preferred PIN code to use when creating access for this reservation. Set to `null` to remove a previously set preferred code, so that access falls back to an automatically generated code. Omitting this field keeps any previously set preferred code.',
45514
+ nullable: true,
45486
45515
  type: 'string',
45487
45516
  },
45488
45517
  property_keys: {
@@ -56827,6 +56856,65 @@ const openapi = {
56827
56856
  'x-undocumented': 'Internal endpoint for customer portals.',
56828
56857
  },
56829
56858
  },
56859
+ '/seam/customer/v1/customers/get': {
56860
+ get: {
56861
+ description: 'Returns a specified customer.',
56862
+ operationId: 'seamCustomerV1CustomersGetGet',
56863
+ parameters: [
56864
+ {
56865
+ in: 'query',
56866
+ name: 'customer_key',
56867
+ schema: {
56868
+ description: 'Key of the customer that you want to get.',
56869
+ minLength: 1,
56870
+ type: 'string',
56871
+ },
56872
+ },
56873
+ {
56874
+ in: 'query',
56875
+ name: 'customer_id',
56876
+ schema: {
56877
+ description: 'ID of the customer that you want to get.',
56878
+ format: 'uuid',
56879
+ type: 'string',
56880
+ },
56881
+ },
56882
+ ],
56883
+ responses: {
56884
+ '200': {
56885
+ content: {
56886
+ 'application/json': {
56887
+ schema: {
56888
+ properties: {
56889
+ customer: { $ref: '#/components/schemas/customer' },
56890
+ ok: { type: 'boolean' },
56891
+ },
56892
+ required: ['customer', 'ok'],
56893
+ type: 'object',
56894
+ },
56895
+ },
56896
+ },
56897
+ description: 'OK',
56898
+ },
56899
+ '400': { description: 'Bad Request' },
56900
+ '401': { description: 'Unauthorized' },
56901
+ },
56902
+ security: [
56903
+ { api_key: [] },
56904
+ { pat_with_workspace: [] },
56905
+ { console_session_with_workspace: [] },
56906
+ ],
56907
+ summary: '/seam/customer/v1/customers/get',
56908
+ tags: [],
56909
+ 'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'customers'],
56910
+ 'x-fern-sdk-method-name': 'get',
56911
+ 'x-fern-sdk-return-value': 'customer',
56912
+ 'x-has-required-parameters': true,
56913
+ 'x-response-key': 'customer',
56914
+ 'x-title': 'Get a Customer',
56915
+ 'x-undocumented': 'Internal endpoint for Console.',
56916
+ },
56917
+ },
56830
56918
  '/seam/customer/v1/customers/list': {
56831
56919
  get: {
56832
56920
  description: 'Returns a list of all customers within the workspace.',