@seamapi/types 1.1162.0 → 1.1164.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.
@@ -49120,7 +49120,7 @@ export type Routes = {
49120
49120
  ends_at?: string | undefined;
49121
49121
  /** 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. */
49122
49122
  preferred_code?: (string | null) | undefined;
49123
- /** Your identifier for the sub-reservation. Must be unique within its reservation. */
49123
+ /** Your identifier for the sub-reservation. Must be unique across all your reservations and sub-reservations, and stay with the same reservation. */
49124
49124
  sub_reservation_key: string;
49125
49125
  /** Whether this is the reservation's primary sub-reservation, for example the room the guest stays in. Only the primary sub-reservation passes the guest's phone number to access systems that require a phone number to be unique per user. At most one sub-reservation of a reservation can be primary. If none is, the first sub-reservation in the list is primary. */
49126
49126
  is_primary?: boolean | undefined;
@@ -49576,7 +49576,7 @@ export type Routes = {
49576
49576
  ends_at?: string | undefined;
49577
49577
  /** 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. */
49578
49578
  preferred_code?: (string | null) | undefined;
49579
- /** Your identifier for the sub-reservation. Must be unique within its reservation. */
49579
+ /** Your identifier for the sub-reservation. Must be unique across all your reservations and sub-reservations, and stay with the same reservation. */
49580
49580
  sub_reservation_key: string;
49581
49581
  /** Whether this is the reservation's primary sub-reservation, for example the room the guest stays in. Only the primary sub-reservation passes the guest's phone number to access systems that require a phone number to be unique per user. At most one sub-reservation of a reservation can be primary. If none is, the first sub-reservation in the list is primary. */
49582
49582
  is_primary?: boolean | undefined;
@@ -91641,6 +91641,52 @@ export type Routes = {
91641
91641
  };
91642
91642
  maxDuration: undefined;
91643
91643
  };
91644
+ '/seam/console/v1/credits/subscription/cancel': {
91645
+ route: '/seam/console/v1/credits/subscription/cancel';
91646
+ method: 'POST';
91647
+ queryParams: {};
91648
+ jsonBody: {
91649
+ organization_id: string;
91650
+ };
91651
+ commonParams: {};
91652
+ formData: {};
91653
+ jsonResponse: {
91654
+ credit_subscription: {
91655
+ credit_subscription_id: string;
91656
+ status: string;
91657
+ package_quantity: number;
91658
+ price_cents: number;
91659
+ current_period_started_at: string | null;
91660
+ current_period_ends_at: string | null;
91661
+ past_due_since: string | null;
91662
+ canceled_at: string | null;
91663
+ };
91664
+ };
91665
+ maxDuration: undefined;
91666
+ };
91667
+ '/seam/console/v1/credits/subscription/resume': {
91668
+ route: '/seam/console/v1/credits/subscription/resume';
91669
+ method: 'POST';
91670
+ queryParams: {};
91671
+ jsonBody: {
91672
+ organization_id: string;
91673
+ };
91674
+ commonParams: {};
91675
+ formData: {};
91676
+ jsonResponse: {
91677
+ credit_subscription: {
91678
+ credit_subscription_id: string;
91679
+ status: string;
91680
+ package_quantity: number;
91681
+ price_cents: number;
91682
+ current_period_started_at: string | null;
91683
+ current_period_ends_at: string | null;
91684
+ past_due_since: string | null;
91685
+ canceled_at: string | null;
91686
+ };
91687
+ };
91688
+ maxDuration: undefined;
91689
+ };
91644
91690
  '/seam/console/v1/get_resource_locator': {
91645
91691
  route: '/seam/console/v1/get_resource_locator';
91646
91692
  method: 'GET' | 'POST';
@@ -100645,7 +100691,7 @@ export type Routes = {
100645
100691
  } | null;
100646
100692
  /** ID of the parent reservation when this reservation is a sub-reservation, one part of a larger reservation that holds its own access. Null otherwise. */
100647
100693
  parent_reservation_id: string | null;
100648
- /** Key of the parent reservation when this reservation is a sub-reservation. Its `reservation_key` is then `<parent_reservation_key>::<sub-reservation key>`. Null otherwise. */
100694
+ /** Key of the parent reservation when this reservation is a sub-reservation. Null otherwise. */
100649
100695
  parent_reservation_key: string | null;
100650
100696
  /** Whether this sub-reservation is its reservation's primary one, the only one that passes the guest's phone number to access systems that require it to be unique per user. Null when this reservation is not a sub-reservation. */
100651
100697
  is_primary: boolean | null;
@@ -100653,6 +100699,8 @@ export type Routes = {
100653
100699
  sub_reservations: {
100654
100700
  sub_reservation_id: string;
100655
100701
  sub_reservation_key: string;
100702
+ /** Key of the reservation this sub-reservation belongs to. */
100703
+ parent_reservation_key: string;
100656
100704
  /** Whether this is the reservation's primary sub-reservation, the only one that passes the guest's phone number to access systems that require it to be unique per user. */
100657
100705
  is_primary: boolean;
100658
100706
  name: string | null;
@@ -100766,6 +100814,8 @@ export type Routes = {
100766
100814
  sub_reservations: {
100767
100815
  sub_reservation_id: string;
100768
100816
  sub_reservation_key: string;
100817
+ /** Key of the reservation this sub-reservation belongs to. */
100818
+ parent_reservation_key: string;
100769
100819
  /** Whether this is the reservation's primary sub-reservation, the only one that passes the guest's phone number to access systems that require it to be unique per user. */
100770
100820
  is_primary: boolean;
100771
100821
  name: string | null;
@@ -101333,7 +101383,7 @@ export type Routes = {
101333
101383
  } | null;
101334
101384
  /** ID of the parent reservation when this reservation is a sub-reservation, one part of a larger reservation that holds its own access. Null otherwise. */
101335
101385
  parent_reservation_id: string | null;
101336
- /** Key of the parent reservation when this reservation is a sub-reservation. Its `reservation_key` is then `<parent_reservation_key>::<sub-reservation key>`. Null otherwise. */
101386
+ /** Key of the parent reservation when this reservation is a sub-reservation. Null otherwise. */
101337
101387
  parent_reservation_key: string | null;
101338
101388
  /** Whether this sub-reservation is its reservation's primary one, the only one that passes the guest's phone number to access systems that require it to be unique per user. Null when this reservation is not a sub-reservation. */
101339
101389
  is_primary: boolean | null;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.1162.0",
3
+ "version": "1.1164.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -90,7 +90,7 @@ export const sub_reservation_resource = base_access_grant_resource
90
90
  message: 'Must not have leading or trailing whitespace',
91
91
  })
92
92
  .describe(
93
- 'Your identifier for the sub-reservation. Must be unique within its reservation.',
93
+ 'Your identifier for the sub-reservation. Must be unique across all your reservations and sub-reservations, and stay with the same reservation.',
94
94
  ),
95
95
  is_primary: z
96
96
  .boolean()
@@ -53827,7 +53827,7 @@ const openapi: OpenAPISpec = {
53827
53827
  },
53828
53828
  sub_reservation_key: {
53829
53829
  description:
53830
- 'Your identifier for the sub-reservation. Must be unique within its reservation.',
53830
+ 'Your identifier for the sub-reservation. Must be unique across all your reservations and sub-reservations, and stay with the same reservation.',
53831
53831
  minLength: 1,
53832
53832
  type: 'string',
53833
53833
  },
@@ -55149,7 +55149,7 @@ const openapi: OpenAPISpec = {
55149
55149
  },
55150
55150
  sub_reservation_key: {
55151
55151
  description:
55152
- 'Your identifier for the sub-reservation. Must be unique within its reservation.',
55152
+ 'Your identifier for the sub-reservation. Must be unique across all your reservations and sub-reservations, and stay with the same reservation.',
55153
55153
  minLength: 1,
55154
55154
  type: 'string',
55155
55155
  },
@@ -62194,6 +62194,194 @@ const openapi: OpenAPISpec = {
62194
62194
  'x-undocumented': 'Internal endpoint for Console',
62195
62195
  },
62196
62196
  },
62197
+ '/seam/console/v1/credits/subscription/cancel': {
62198
+ post: {
62199
+ description:
62200
+ "Cancels the organization's credit subscription at the end of its current period. The package stays available until then.",
62201
+ operationId: 'seamConsoleV1CreditsSubscriptionCancelPost',
62202
+ requestBody: {
62203
+ content: {
62204
+ 'application/json': {
62205
+ schema: {
62206
+ properties: {
62207
+ organization_id: { format: 'uuid', type: 'string' },
62208
+ },
62209
+ required: ['organization_id'],
62210
+ type: 'object',
62211
+ },
62212
+ },
62213
+ },
62214
+ },
62215
+ responses: {
62216
+ '200': {
62217
+ content: {
62218
+ 'application/json': {
62219
+ schema: {
62220
+ properties: {
62221
+ credit_subscription: {
62222
+ properties: {
62223
+ canceled_at: {
62224
+ format: 'date-time',
62225
+ nullable: true,
62226
+ type: 'string',
62227
+ },
62228
+ credit_subscription_id: {
62229
+ format: 'uuid',
62230
+ type: 'string',
62231
+ },
62232
+ current_period_ends_at: {
62233
+ format: 'date-time',
62234
+ nullable: true,
62235
+ type: 'string',
62236
+ },
62237
+ current_period_started_at: {
62238
+ format: 'date-time',
62239
+ nullable: true,
62240
+ type: 'string',
62241
+ },
62242
+ package_quantity: { format: 'float', type: 'number' },
62243
+ past_due_since: {
62244
+ format: 'date-time',
62245
+ nullable: true,
62246
+ type: 'string',
62247
+ },
62248
+ price_cents: { format: 'float', type: 'number' },
62249
+ status: { type: 'string' },
62250
+ },
62251
+ required: [
62252
+ 'credit_subscription_id',
62253
+ 'status',
62254
+ 'package_quantity',
62255
+ 'price_cents',
62256
+ 'current_period_started_at',
62257
+ 'current_period_ends_at',
62258
+ 'past_due_since',
62259
+ 'canceled_at',
62260
+ ],
62261
+ type: 'object',
62262
+ },
62263
+ ok: { type: 'boolean' },
62264
+ },
62265
+ required: ['credit_subscription', 'ok'],
62266
+ type: 'object',
62267
+ },
62268
+ },
62269
+ },
62270
+ description: 'OK',
62271
+ },
62272
+ '400': { description: 'Bad Request' },
62273
+ '401': { description: 'Unauthorized' },
62274
+ },
62275
+ security: [{ console_session_without_workspace: [] }],
62276
+ summary: '/seam/console/v1/credits/subscription/cancel',
62277
+ tags: [],
62278
+ 'x-fern-sdk-group-name': [
62279
+ 'seam',
62280
+ 'console',
62281
+ 'v1',
62282
+ 'credits',
62283
+ 'subscription',
62284
+ ],
62285
+ 'x-fern-sdk-method-name': 'cancel',
62286
+ 'x-response-key': null,
62287
+ 'x-title': 'Cancel a Credit Subscription at Period End',
62288
+ 'x-undocumented': 'Internal endpoint for Console',
62289
+ },
62290
+ },
62291
+ '/seam/console/v1/credits/subscription/resume': {
62292
+ post: {
62293
+ description:
62294
+ 'Undoes a cancellation that has not taken effect yet, so the credit subscription renews at the end of its current period.',
62295
+ operationId: 'seamConsoleV1CreditsSubscriptionResumePost',
62296
+ requestBody: {
62297
+ content: {
62298
+ 'application/json': {
62299
+ schema: {
62300
+ properties: {
62301
+ organization_id: { format: 'uuid', type: 'string' },
62302
+ },
62303
+ required: ['organization_id'],
62304
+ type: 'object',
62305
+ },
62306
+ },
62307
+ },
62308
+ },
62309
+ responses: {
62310
+ '200': {
62311
+ content: {
62312
+ 'application/json': {
62313
+ schema: {
62314
+ properties: {
62315
+ credit_subscription: {
62316
+ properties: {
62317
+ canceled_at: {
62318
+ format: 'date-time',
62319
+ nullable: true,
62320
+ type: 'string',
62321
+ },
62322
+ credit_subscription_id: {
62323
+ format: 'uuid',
62324
+ type: 'string',
62325
+ },
62326
+ current_period_ends_at: {
62327
+ format: 'date-time',
62328
+ nullable: true,
62329
+ type: 'string',
62330
+ },
62331
+ current_period_started_at: {
62332
+ format: 'date-time',
62333
+ nullable: true,
62334
+ type: 'string',
62335
+ },
62336
+ package_quantity: { format: 'float', type: 'number' },
62337
+ past_due_since: {
62338
+ format: 'date-time',
62339
+ nullable: true,
62340
+ type: 'string',
62341
+ },
62342
+ price_cents: { format: 'float', type: 'number' },
62343
+ status: { type: 'string' },
62344
+ },
62345
+ required: [
62346
+ 'credit_subscription_id',
62347
+ 'status',
62348
+ 'package_quantity',
62349
+ 'price_cents',
62350
+ 'current_period_started_at',
62351
+ 'current_period_ends_at',
62352
+ 'past_due_since',
62353
+ 'canceled_at',
62354
+ ],
62355
+ type: 'object',
62356
+ },
62357
+ ok: { type: 'boolean' },
62358
+ },
62359
+ required: ['credit_subscription', 'ok'],
62360
+ type: 'object',
62361
+ },
62362
+ },
62363
+ },
62364
+ description: 'OK',
62365
+ },
62366
+ '400': { description: 'Bad Request' },
62367
+ '401': { description: 'Unauthorized' },
62368
+ },
62369
+ security: [{ console_session_without_workspace: [] }],
62370
+ summary: '/seam/console/v1/credits/subscription/resume',
62371
+ tags: [],
62372
+ 'x-fern-sdk-group-name': [
62373
+ 'seam',
62374
+ 'console',
62375
+ 'v1',
62376
+ 'credits',
62377
+ 'subscription',
62378
+ ],
62379
+ 'x-fern-sdk-method-name': 'resume',
62380
+ 'x-response-key': null,
62381
+ 'x-title': 'Resume a Canceled Credit Subscription',
62382
+ 'x-undocumented': 'Internal endpoint for Console',
62383
+ },
62384
+ },
62197
62385
  '/seam/console/v1/get_resource_locator': {
62198
62386
  get: {
62199
62387
  description:
@@ -70994,7 +71182,7 @@ const openapi: OpenAPISpec = {
70994
71182
  },
70995
71183
  parent_reservation_key: {
70996
71184
  description:
70997
- 'Key of the parent reservation when this reservation is a sub-reservation. Its `reservation_key` is then `<parent_reservation_key>::<sub-reservation key>`. Null otherwise.',
71185
+ 'Key of the parent reservation when this reservation is a sub-reservation. Null otherwise.',
70998
71186
  nullable: true,
70999
71187
  type: 'string',
71000
71188
  },
@@ -71049,6 +71237,11 @@ const openapi: OpenAPISpec = {
71049
71237
  },
71050
71238
  is_resource_syncing: { type: 'boolean' },
71051
71239
  name: { nullable: true, type: 'string' },
71240
+ parent_reservation_key: {
71241
+ description:
71242
+ 'Key of the reservation this sub-reservation belongs to.',
71243
+ type: 'string',
71244
+ },
71052
71245
  spaces: {
71053
71246
  items: {
71054
71247
  properties: {
@@ -71079,6 +71272,7 @@ const openapi: OpenAPISpec = {
71079
71272
  required: [
71080
71273
  'sub_reservation_id',
71081
71274
  'sub_reservation_key',
71275
+ 'parent_reservation_key',
71082
71276
  'is_primary',
71083
71277
  'name',
71084
71278
  'starts_at',
@@ -71461,6 +71655,11 @@ const openapi: OpenAPISpec = {
71461
71655
  },
71462
71656
  is_resource_syncing: { type: 'boolean' },
71463
71657
  name: { nullable: true, type: 'string' },
71658
+ parent_reservation_key: {
71659
+ description:
71660
+ 'Key of the reservation this sub-reservation belongs to.',
71661
+ type: 'string',
71662
+ },
71464
71663
  spaces: {
71465
71664
  items: {
71466
71665
  properties: {
@@ -71491,6 +71690,7 @@ const openapi: OpenAPISpec = {
71491
71690
  required: [
71492
71691
  'sub_reservation_id',
71493
71692
  'sub_reservation_key',
71693
+ 'parent_reservation_key',
71494
71694
  'is_primary',
71495
71695
  'name',
71496
71696
  'starts_at',
@@ -72317,7 +72517,7 @@ const openapi: OpenAPISpec = {
72317
72517
  },
72318
72518
  parent_reservation_key: {
72319
72519
  description:
72320
- 'Key of the parent reservation when this reservation is a sub-reservation. Its `reservation_key` is then `<parent_reservation_key>::<sub-reservation key>`. Null otherwise.',
72520
+ 'Key of the parent reservation when this reservation is a sub-reservation. Null otherwise.',
72321
72521
  nullable: true,
72322
72522
  type: 'string',
72323
72523
  },
@@ -57307,7 +57307,7 @@ export type Routes = {
57307
57307
  ends_at?: string | undefined
57308
57308
  /** 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. */
57309
57309
  preferred_code?: (string | null) | undefined
57310
- /** Your identifier for the sub-reservation. Must be unique within its reservation. */
57310
+ /** Your identifier for the sub-reservation. Must be unique across all your reservations and sub-reservations, and stay with the same reservation. */
57311
57311
  sub_reservation_key: string
57312
57312
  /** Whether this is the reservation's primary sub-reservation, for example the room the guest stays in. Only the primary sub-reservation passes the guest's phone number to access systems that require a phone number to be unique per user. At most one sub-reservation of a reservation can be primary. If none is, the first sub-reservation in the list is primary. */
57313
57313
  is_primary?: boolean | undefined
@@ -57814,7 +57814,7 @@ export type Routes = {
57814
57814
  ends_at?: string | undefined
57815
57815
  /** 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. */
57816
57816
  preferred_code?: (string | null) | undefined
57817
- /** Your identifier for the sub-reservation. Must be unique within its reservation. */
57817
+ /** Your identifier for the sub-reservation. Must be unique across all your reservations and sub-reservations, and stay with the same reservation. */
57818
57818
  sub_reservation_key: string
57819
57819
  /** Whether this is the reservation's primary sub-reservation, for example the room the guest stays in. Only the primary sub-reservation passes the guest's phone number to access systems that require a phone number to be unique per user. At most one sub-reservation of a reservation can be primary. If none is, the first sub-reservation in the list is primary. */
57820
57820
  is_primary?: boolean | undefined
@@ -109500,6 +109500,52 @@ export type Routes = {
109500
109500
  }
109501
109501
  maxDuration: undefined
109502
109502
  }
109503
+ '/seam/console/v1/credits/subscription/cancel': {
109504
+ route: '/seam/console/v1/credits/subscription/cancel'
109505
+ method: 'POST'
109506
+ queryParams: {}
109507
+ jsonBody: {
109508
+ organization_id: string
109509
+ }
109510
+ commonParams: {}
109511
+ formData: {}
109512
+ jsonResponse: {
109513
+ credit_subscription: {
109514
+ credit_subscription_id: string
109515
+ status: string
109516
+ package_quantity: number
109517
+ price_cents: number
109518
+ current_period_started_at: string | null
109519
+ current_period_ends_at: string | null
109520
+ past_due_since: string | null
109521
+ canceled_at: string | null
109522
+ }
109523
+ }
109524
+ maxDuration: undefined
109525
+ }
109526
+ '/seam/console/v1/credits/subscription/resume': {
109527
+ route: '/seam/console/v1/credits/subscription/resume'
109528
+ method: 'POST'
109529
+ queryParams: {}
109530
+ jsonBody: {
109531
+ organization_id: string
109532
+ }
109533
+ commonParams: {}
109534
+ formData: {}
109535
+ jsonResponse: {
109536
+ credit_subscription: {
109537
+ credit_subscription_id: string
109538
+ status: string
109539
+ package_quantity: number
109540
+ price_cents: number
109541
+ current_period_started_at: string | null
109542
+ current_period_ends_at: string | null
109543
+ past_due_since: string | null
109544
+ canceled_at: string | null
109545
+ }
109546
+ }
109547
+ maxDuration: undefined
109548
+ }
109503
109549
  '/seam/console/v1/get_resource_locator': {
109504
109550
  route: '/seam/console/v1/get_resource_locator'
109505
109551
  method: 'GET' | 'POST'
@@ -120075,7 +120121,7 @@ export type Routes = {
120075
120121
  } | null
120076
120122
  /** ID of the parent reservation when this reservation is a sub-reservation, one part of a larger reservation that holds its own access. Null otherwise. */
120077
120123
  parent_reservation_id: string | null
120078
- /** Key of the parent reservation when this reservation is a sub-reservation. Its `reservation_key` is then `<parent_reservation_key>::<sub-reservation key>`. Null otherwise. */
120124
+ /** Key of the parent reservation when this reservation is a sub-reservation. Null otherwise. */
120079
120125
  parent_reservation_key: string | null
120080
120126
  /** Whether this sub-reservation is its reservation's primary one, the only one that passes the guest's phone number to access systems that require it to be unique per user. Null when this reservation is not a sub-reservation. */
120081
120127
  is_primary: boolean | null
@@ -120083,6 +120129,8 @@ export type Routes = {
120083
120129
  sub_reservations: {
120084
120130
  sub_reservation_id: string
120085
120131
  sub_reservation_key: string
120132
+ /** Key of the reservation this sub-reservation belongs to. */
120133
+ parent_reservation_key: string
120086
120134
  /** Whether this is the reservation's primary sub-reservation, the only one that passes the guest's phone number to access systems that require it to be unique per user. */
120087
120135
  is_primary: boolean
120088
120136
  name: string | null
@@ -120196,6 +120244,8 @@ export type Routes = {
120196
120244
  sub_reservations: {
120197
120245
  sub_reservation_id: string
120198
120246
  sub_reservation_key: string
120247
+ /** Key of the reservation this sub-reservation belongs to. */
120248
+ parent_reservation_key: string
120199
120249
  /** Whether this is the reservation's primary sub-reservation, the only one that passes the guest's phone number to access systems that require it to be unique per user. */
120200
120250
  is_primary: boolean
120201
120251
  name: string | null
@@ -120824,7 +120874,7 @@ export type Routes = {
120824
120874
  } | null
120825
120875
  /** ID of the parent reservation when this reservation is a sub-reservation, one part of a larger reservation that holds its own access. Null otherwise. */
120826
120876
  parent_reservation_id: string | null
120827
- /** Key of the parent reservation when this reservation is a sub-reservation. Its `reservation_key` is then `<parent_reservation_key>::<sub-reservation key>`. Null otherwise. */
120877
+ /** Key of the parent reservation when this reservation is a sub-reservation. Null otherwise. */
120828
120878
  parent_reservation_key: string | null
120829
120879
  /** Whether this sub-reservation is its reservation's primary one, the only one that passes the guest's phone number to access systems that require it to be unique per user. Null when this reservation is not a sub-reservation. */
120830
120880
  is_primary: boolean | null