@seamapi/types 1.767.0 → 1.768.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.
@@ -78655,6 +78655,7 @@ declare const _default: {
78655
78655
  required: string[];
78656
78656
  type: string;
78657
78657
  'x-route-path': string;
78658
+ 'x-undocumented': string;
78658
78659
  };
78659
78660
  thermostat_daily_program: {
78660
78661
  description: string;
@@ -82340,6 +82341,7 @@ declare const _default: {
82340
82341
  };
82341
82342
  timeline_events: {
82342
82343
  items: {
82344
+ description: string;
82343
82345
  properties: {
82344
82346
  actor: {
82345
82347
  description: string;
@@ -82376,6 +82378,7 @@ declare const _default: {
82376
82378
  description: string;
82377
82379
  enum: string[];
82378
82380
  type: string;
82381
+ 'x-undocumented': string;
82379
82382
  };
82380
82383
  occurred_at: {
82381
82384
  description: string;
@@ -82412,6 +82415,7 @@ declare const _default: {
82412
82415
  };
82413
82416
  required: string[];
82414
82417
  type: string;
82418
+ 'x-undocumented': string;
82415
82419
  };
82416
82420
  type: string;
82417
82421
  };
@@ -82468,6 +82472,7 @@ declare const _default: {
82468
82472
  'x-fern-sdk-return-value': string;
82469
82473
  'x-response-key': string;
82470
82474
  'x-title': string;
82475
+ 'x-undocumented': string;
82471
82476
  };
82472
82477
  post: {
82473
82478
  description: string;
@@ -82543,6 +82548,7 @@ declare const _default: {
82543
82548
  };
82544
82549
  timeline_events: {
82545
82550
  items: {
82551
+ description: string;
82546
82552
  properties: {
82547
82553
  actor: {
82548
82554
  description: string;
@@ -82579,6 +82585,7 @@ declare const _default: {
82579
82585
  description: string;
82580
82586
  enum: string[];
82581
82587
  type: string;
82588
+ 'x-undocumented': string;
82582
82589
  };
82583
82590
  occurred_at: {
82584
82591
  description: string;
@@ -82615,6 +82622,7 @@ declare const _default: {
82615
82622
  };
82616
82623
  required: string[];
82617
82624
  type: string;
82625
+ 'x-undocumented': string;
82618
82626
  };
82619
82627
  type: string;
82620
82628
  };
@@ -82671,6 +82679,7 @@ declare const _default: {
82671
82679
  'x-fern-sdk-return-value': string;
82672
82680
  'x-response-key': string;
82673
82681
  'x-title': string;
82682
+ 'x-undocumented': string;
82674
82683
  };
82675
82684
  };
82676
82685
  '/access_codes/list': {
@@ -101381,6 +101390,7 @@ declare const _default: {
101381
101390
  };
101382
101391
  required: string[];
101383
101392
  type: string;
101393
+ 'x-undocumented': string;
101384
101394
  };
101385
101395
  exclude_locale_picker: {
101386
101396
  default: boolean;
@@ -102443,6 +102453,7 @@ declare const _default: {
102443
102453
  required: string[];
102444
102454
  type: string;
102445
102455
  'x-route-path': string;
102456
+ 'x-undocumented': string;
102446
102457
  };
102447
102458
  type: string;
102448
102459
  };
@@ -103573,6 +103584,7 @@ declare const _default: {
103573
103584
  required: string[];
103574
103585
  type: string;
103575
103586
  'x-route-path': string;
103587
+ 'x-undocumented': string;
103576
103588
  };
103577
103589
  type: string;
103578
103590
  };
@@ -103822,6 +103834,7 @@ declare const _default: {
103822
103834
  'x-fern-sdk-return-value': string;
103823
103835
  'x-response-key': string;
103824
103836
  'x-title': string;
103837
+ 'x-undocumented': string;
103825
103838
  };
103826
103839
  };
103827
103840
  '/devices/delete': {
@@ -115447,6 +115460,7 @@ declare const _default: {
115447
115460
  'x-fern-sdk-return-value': string;
115448
115461
  'x-response-key': string;
115449
115462
  'x-title': string;
115463
+ 'x-undocumented': string;
115450
115464
  };
115451
115465
  post: {
115452
115466
  description: string;
@@ -115734,6 +115748,7 @@ declare const _default: {
115734
115748
  'x-fern-sdk-return-value': string;
115735
115749
  'x-response-key': string;
115736
115750
  'x-title': string;
115751
+ 'x-undocumented': string;
115737
115752
  };
115738
115753
  };
115739
115754
  '/seam/customer/v1/customers/automations/update': {
@@ -116038,6 +116053,7 @@ declare const _default: {
116038
116053
  'x-fern-sdk-method-name': string;
116039
116054
  'x-response-key': null;
116040
116055
  'x-title': string;
116056
+ 'x-undocumented': string;
116041
116057
  };
116042
116058
  post: {
116043
116059
  description: string;
@@ -116340,6 +116356,7 @@ declare const _default: {
116340
116356
  'x-fern-sdk-method-name': string;
116341
116357
  'x-response-key': null;
116342
116358
  'x-title': string;
116359
+ 'x-undocumented': string;
116343
116360
  };
116344
116361
  };
116345
116362
  '/seam/customer/v1/customers/list': {
@@ -116574,6 +116591,7 @@ declare const _default: {
116574
116591
  'x-fern-sdk-method-name': string;
116575
116592
  'x-response-key': null;
116576
116593
  'x-title': string;
116594
+ 'x-undocumented': string;
116577
116595
  };
116578
116596
  post: {
116579
116597
  description: string;
@@ -116623,6 +116641,7 @@ declare const _default: {
116623
116641
  'x-fern-sdk-method-name': string;
116624
116642
  'x-response-key': null;
116625
116643
  'x-title': string;
116644
+ 'x-undocumented': string;
116626
116645
  };
116627
116646
  };
116628
116647
  '/seam/customer/v1/customers/open_portal': {
@@ -117127,6 +117146,7 @@ declare const _default: {
117127
117146
  };
117128
117147
  required: string[];
117129
117148
  type: string;
117149
+ 'x-undocumented': string;
117130
117150
  };
117131
117151
  exclude_locale_picker: {
117132
117152
  default: boolean;
@@ -117614,6 +117634,7 @@ declare const _default: {
117614
117634
  };
117615
117635
  required: string[];
117616
117636
  type: string;
117637
+ 'x-undocumented': string;
117617
117638
  };
117618
117639
  exclude_locale_picker: {
117619
117640
  default: boolean;
@@ -120538,6 +120559,7 @@ declare const _default: {
120538
120559
  'x-fern-sdk-method-name': string;
120539
120560
  'x-response-key': null;
120540
120561
  'x-title': string;
120562
+ 'x-undocumented': string;
120541
120563
  };
120542
120564
  };
120543
120565
  '/seam/customer/v1/staff_members/get': {
@@ -120617,6 +120639,7 @@ declare const _default: {
120617
120639
  required: string[];
120618
120640
  type: string;
120619
120641
  'x-route-path': string;
120642
+ 'x-undocumented': string;
120620
120643
  };
120621
120644
  };
120622
120645
  required: string[];
@@ -120728,6 +120751,7 @@ declare const _default: {
120728
120751
  required: string[];
120729
120752
  type: string;
120730
120753
  'x-route-path': string;
120754
+ 'x-undocumented': string;
120731
120755
  };
120732
120756
  };
120733
120757
  required: string[];
@@ -120857,6 +120881,7 @@ declare const _default: {
120857
120881
  required: string[];
120858
120882
  type: string;
120859
120883
  'x-route-path': string;
120884
+ 'x-undocumented': string;
120860
120885
  };
120861
120886
  type: string;
120862
120887
  };
@@ -120974,6 +120999,7 @@ declare const _default: {
120974
120999
  required: string[];
120975
121000
  type: string;
120976
121001
  'x-route-path': string;
121002
+ 'x-undocumented': string;
120977
121003
  };
120978
121004
  type: string;
120979
121005
  };
package/dist/index.cjs CHANGED
@@ -6544,6 +6544,7 @@ var staff_member_resource = base_user_identity_resource.extend({
6544
6544
  }).describe(`
6545
6545
  ---
6546
6546
  route_path: /seam/customer/v1/staff_members
6547
+ undocumented: Internal resource for customer portals.
6547
6548
  ---
6548
6549
  Represents a staff member for a specific customer.
6549
6550
  `);
@@ -29440,7 +29441,8 @@ var openapi_default = {
29440
29441
  },
29441
29442
  required: ["name", "staff_member_key"],
29442
29443
  type: "object",
29443
- "x-route-path": "/seam/customer/v1/staff_members"
29444
+ "x-route-path": "/seam/customer/v1/staff_members",
29445
+ "x-undocumented": "Internal resource for customer portals."
29444
29446
  },
29445
29447
  thermostat_daily_program: {
29446
29448
  description: "Represents a thermostat daily program, consisting of a set of periods, each of which has a starting time and the key that identifies the climate preset to apply at the starting time.",
@@ -35170,6 +35172,7 @@ var openapi_default = {
35170
35172
  },
35171
35173
  timeline_events: {
35172
35174
  items: {
35175
+ description: "Timeline event for access code lifecycle activity.",
35173
35176
  properties: {
35174
35177
  actor: {
35175
35178
  description: "Information about who or what triggered this event.",
@@ -35228,7 +35231,8 @@ var openapi_default = {
35228
35231
  "access_code.unmanaged.converted_to_managed",
35229
35232
  "access_code.unmanaged.failed_to_convert_to_managed"
35230
35233
  ],
35231
- type: "string"
35234
+ type: "string",
35235
+ "x-undocumented": "Unreleased."
35232
35236
  },
35233
35237
  occurred_at: {
35234
35238
  description: "ISO 8601 timestamp when the event occurred.",
@@ -35264,7 +35268,8 @@ var openapi_default = {
35264
35268
  "description",
35265
35269
  "actor"
35266
35270
  ],
35267
- type: "object"
35271
+ type: "object",
35272
+ "x-undocumented": "Unreleased."
35268
35273
  },
35269
35274
  type: "array"
35270
35275
  }
@@ -35292,7 +35297,8 @@ var openapi_default = {
35292
35297
  "x-fern-sdk-method-name": "get_timeline",
35293
35298
  "x-fern-sdk-return-value": "timeline_events",
35294
35299
  "x-response-key": "timeline_events",
35295
- "x-title": "Get Access Code Timeline"
35300
+ "x-title": "Get Access Code Timeline",
35301
+ "x-undocumented": "Unreleased."
35296
35302
  },
35297
35303
  post: {
35298
35304
  description: "Returns a chronological timeline of events for an access code.\n\nThe timeline includes state changes (create, update, delete), delivery lifecycle events\n(programming attempts, success/failure), and related device events.",
@@ -35376,6 +35382,7 @@ var openapi_default = {
35376
35382
  },
35377
35383
  timeline_events: {
35378
35384
  items: {
35385
+ description: "Timeline event for access code lifecycle activity.",
35379
35386
  properties: {
35380
35387
  actor: {
35381
35388
  description: "Information about who or what triggered this event.",
@@ -35434,7 +35441,8 @@ var openapi_default = {
35434
35441
  "access_code.unmanaged.converted_to_managed",
35435
35442
  "access_code.unmanaged.failed_to_convert_to_managed"
35436
35443
  ],
35437
- type: "string"
35444
+ type: "string",
35445
+ "x-undocumented": "Unreleased."
35438
35446
  },
35439
35447
  occurred_at: {
35440
35448
  description: "ISO 8601 timestamp when the event occurred.",
@@ -35470,7 +35478,8 @@ var openapi_default = {
35470
35478
  "description",
35471
35479
  "actor"
35472
35480
  ],
35473
- type: "object"
35481
+ type: "object",
35482
+ "x-undocumented": "Unreleased."
35474
35483
  },
35475
35484
  type: "array"
35476
35485
  }
@@ -35498,7 +35507,8 @@ var openapi_default = {
35498
35507
  "x-fern-sdk-method-name": "get_timeline",
35499
35508
  "x-fern-sdk-return-value": "timeline_events",
35500
35509
  "x-response-key": "timeline_events",
35501
- "x-title": "Get Access Code Timeline"
35510
+ "x-title": "Get Access Code Timeline",
35511
+ "x-undocumented": "Unreleased."
35502
35512
  }
35503
35513
  },
35504
35514
  "/access_codes/list": {
@@ -51723,7 +51733,8 @@ var openapi_default = {
51723
51733
  }
51724
51734
  },
51725
51735
  required: ["resource_type", "resource_key"],
51726
- type: "object"
51736
+ type: "object",
51737
+ "x-undocumented": "Internal endpoint for customer portals."
51727
51738
  },
51728
51739
  exclude_locale_picker: {
51729
51740
  default: false,
@@ -52599,7 +52610,8 @@ var openapi_default = {
52599
52610
  },
52600
52611
  required: ["name", "staff_member_key"],
52601
52612
  type: "object",
52602
- "x-route-path": "/seam/customer/v1/staff_members"
52613
+ "x-route-path": "/seam/customer/v1/staff_members",
52614
+ "x-undocumented": "Internal resource for customer portals."
52603
52615
  },
52604
52616
  type: "array"
52605
52617
  },
@@ -53720,7 +53732,8 @@ var openapi_default = {
53720
53732
  },
53721
53733
  required: ["name", "staff_member_key"],
53722
53734
  type: "object",
53723
- "x-route-path": "/seam/customer/v1/staff_members"
53735
+ "x-route-path": "/seam/customer/v1/staff_members",
53736
+ "x-undocumented": "Internal resource for customer portals."
53724
53737
  },
53725
53738
  type: "array"
53726
53739
  },
@@ -53939,7 +53952,8 @@ var openapi_default = {
53939
53952
  "x-fern-sdk-method-name": "create_deep_link",
53940
53953
  "x-fern-sdk-return-value": "deep_link",
53941
53954
  "x-response-key": "deep_link",
53942
- "x-title": "Create Reservation Deep Link"
53955
+ "x-title": "Create Reservation Deep Link",
53956
+ "x-undocumented": "Internal endpoint for customer portals."
53943
53957
  }
53944
53958
  },
53945
53959
  "/devices/delete": {
@@ -65599,7 +65613,8 @@ var openapi_default = {
65599
65613
  "x-fern-sdk-method-name": "get",
65600
65614
  "x-fern-sdk-return-value": "automation",
65601
65615
  "x-response-key": "automation",
65602
- "x-title": "Get Customer Automation Configuration"
65616
+ "x-title": "Get Customer Automation Configuration",
65617
+ "x-undocumented": "Internal endpoint for customer portals."
65603
65618
  },
65604
65619
  post: {
65605
65620
  description: "Gets the automation configuration for the authenticated customer.\nReturns the merged configuration (customer overrides on top of workspace defaults).",
@@ -65895,7 +65910,8 @@ var openapi_default = {
65895
65910
  "x-fern-sdk-method-name": "get",
65896
65911
  "x-fern-sdk-return-value": "automation",
65897
65912
  "x-response-key": "automation",
65898
- "x-title": "Get Customer Automation Configuration"
65913
+ "x-title": "Get Customer Automation Configuration",
65914
+ "x-undocumented": "Internal endpoint for customer portals."
65899
65915
  }
65900
65916
  },
65901
65917
  "/seam/customer/v1/customers/automations/update": {
@@ -66181,7 +66197,8 @@ var openapi_default = {
66181
66197
  ],
66182
66198
  "x-fern-sdk-method-name": "update",
66183
66199
  "x-response-key": null,
66184
- "x-title": "Update Customer Automation Configuration"
66200
+ "x-title": "Update Customer Automation Configuration",
66201
+ "x-undocumented": "Internal endpoint for customer portals."
66185
66202
  },
66186
66203
  post: {
66187
66204
  description: "Updates the automation configuration for a specific customer.\nCreates a customer-level override if one does not already exist.",
@@ -66465,7 +66482,8 @@ var openapi_default = {
66465
66482
  ],
66466
66483
  "x-fern-sdk-method-name": "update",
66467
66484
  "x-response-key": null,
66468
- "x-title": "Update Customer Automation Configuration"
66485
+ "x-title": "Update Customer Automation Configuration",
66486
+ "x-undocumented": "Internal endpoint for customer portals."
66469
66487
  }
66470
66488
  },
66471
66489
  "/seam/customer/v1/customers/list": {
@@ -66643,7 +66661,8 @@ var openapi_default = {
66643
66661
  "x-fern-sdk-group-name": ["seam", "customer", "v1", "customers"],
66644
66662
  "x-fern-sdk-method-name": "me",
66645
66663
  "x-response-key": null,
66646
- "x-title": "Me"
66664
+ "x-title": "Me",
66665
+ "x-undocumented": "Internal endpoint for customer portals."
66647
66666
  },
66648
66667
  post: {
66649
66668
  description: "Returns the customer associated with the authenticated client session.",
@@ -66678,7 +66697,8 @@ var openapi_default = {
66678
66697
  "x-fern-sdk-group-name": ["seam", "customer", "v1", "customers"],
66679
66698
  "x-fern-sdk-method-name": "me",
66680
66699
  "x-response-key": null,
66681
- "x-title": "Me"
66700
+ "x-title": "Me",
66701
+ "x-undocumented": "Internal endpoint for customer portals."
66682
66702
  }
66683
66703
  },
66684
66704
  "/seam/customer/v1/customers/open_portal": {
@@ -67522,7 +67542,8 @@ var openapi_default = {
67522
67542
  }
67523
67543
  },
67524
67544
  required: ["resource_type", "resource_key"],
67525
- type: "object"
67545
+ type: "object",
67546
+ "x-undocumented": "Internal endpoint for customer portals."
67526
67547
  },
67527
67548
  exclude_locale_picker: {
67528
67549
  default: false,
@@ -67895,7 +67916,8 @@ var openapi_default = {
67895
67916
  }
67896
67917
  },
67897
67918
  required: ["resource_type", "resource_key"],
67898
- type: "object"
67919
+ type: "object",
67920
+ "x-undocumented": "Internal endpoint for customer portals."
67899
67921
  },
67900
67922
  exclude_locale_picker: {
67901
67923
  default: false,
@@ -70506,7 +70528,8 @@ var openapi_default = {
70506
70528
  "x-fern-sdk-group-name": ["seam", "customer", "v1", "spaces"],
70507
70529
  "x-fern-sdk-method-name": "push_common_areas",
70508
70530
  "x-response-key": null,
70509
- "x-title": "Push Common Areas"
70531
+ "x-title": "Push Common Areas",
70532
+ "x-undocumented": "Internal endpoint for customer portals."
70510
70533
  }
70511
70534
  },
70512
70535
  "/seam/customer/v1/staff_members/get": {
@@ -70574,7 +70597,8 @@ var openapi_default = {
70574
70597
  },
70575
70598
  required: ["staff_member_key", "name"],
70576
70599
  type: "object",
70577
- "x-route-path": "/seam/customer/v1/staff_members"
70600
+ "x-route-path": "/seam/customer/v1/staff_members",
70601
+ "x-undocumented": "Internal resource for customer portals."
70578
70602
  }
70579
70603
  },
70580
70604
  required: ["access_grant", "spaces", "staff_member", "ok"],
@@ -70666,7 +70690,8 @@ var openapi_default = {
70666
70690
  },
70667
70691
  required: ["staff_member_key", "name"],
70668
70692
  type: "object",
70669
- "x-route-path": "/seam/customer/v1/staff_members"
70693
+ "x-route-path": "/seam/customer/v1/staff_members",
70694
+ "x-undocumented": "Internal resource for customer portals."
70670
70695
  }
70671
70696
  },
70672
70697
  required: ["access_grant", "spaces", "staff_member", "ok"],
@@ -70779,7 +70804,8 @@ var openapi_default = {
70779
70804
  },
70780
70805
  required: ["staff_member_key", "name"],
70781
70806
  type: "object",
70782
- "x-route-path": "/seam/customer/v1/staff_members"
70807
+ "x-route-path": "/seam/customer/v1/staff_members",
70808
+ "x-undocumented": "Internal resource for customer portals."
70783
70809
  },
70784
70810
  type: "array"
70785
70811
  }
@@ -70881,7 +70907,8 @@ var openapi_default = {
70881
70907
  },
70882
70908
  required: ["staff_member_key", "name"],
70883
70909
  type: "object",
70884
- "x-route-path": "/seam/customer/v1/staff_members"
70910
+ "x-route-path": "/seam/customer/v1/staff_members",
70911
+ "x-undocumented": "Internal resource for customer portals."
70885
70912
  },
70886
70913
  type: "array"
70887
70914
  }