@seamapi/types 1.682.0 → 1.684.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.
package/dist/connect.cjs CHANGED
@@ -2526,11 +2526,15 @@ var unknown_issue_with_acs_access_group = common_acs_access_group_warning.extend
2526
2526
  }).describe(
2527
2527
  "An unknown issue occurred while syncing the state of this access group with the provider. This issue may affect the proper functioning of this access group."
2528
2528
  );
2529
- var acs_access_group_warning = unknown_issue_with_acs_access_group.describe(
2530
- "Warning associated with the `acs_access_group`."
2529
+ var acs_access_group_being_deleted = common_acs_access_group_warning.extend({
2530
+ warning_code: zod.z.literal("being_deleted").describe(warning_code_description6)
2531
+ }).describe(
2532
+ "Indicates that the access group is being deleted from the access system. This is a temporary state, and the access group will be deleted shortly."
2531
2533
  );
2534
+ var acs_access_group_warning = zod.z.union([unknown_issue_with_acs_access_group, acs_access_group_being_deleted]).describe("Warning associated with the `acs_access_group`.");
2532
2535
  zod.z.object({
2533
- unknown_issue_with_acs_access_group: unknown_issue_with_acs_access_group.optional().nullable()
2536
+ unknown_issue_with_acs_access_group: unknown_issue_with_acs_access_group.optional().nullable(),
2537
+ being_deleted: acs_access_group_being_deleted.optional().nullable()
2534
2538
  });
2535
2539
  var common_acs_access_group = zod.z.object({
2536
2540
  acs_access_group_id: zod.z.string().uuid().describe("ID of the access group."),
@@ -7837,24 +7841,50 @@ var openapi_default = {
7837
7841
  description: "Warnings associated with the `acs_access_group`.",
7838
7842
  items: {
7839
7843
  description: "Warning associated with the `acs_access_group`.",
7840
- properties: {
7841
- created_at: {
7842
- description: "Date and time at which Seam created the warning.",
7843
- format: "date-time",
7844
- type: "string"
7845
- },
7846
- message: {
7847
- description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
7848
- type: "string"
7844
+ oneOf: [
7845
+ {
7846
+ description: "An unknown issue occurred while syncing the state of this access group with the provider. This issue may affect the proper functioning of this access group.",
7847
+ properties: {
7848
+ created_at: {
7849
+ description: "Date and time at which Seam created the warning.",
7850
+ format: "date-time",
7851
+ type: "string"
7852
+ },
7853
+ message: {
7854
+ description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
7855
+ type: "string"
7856
+ },
7857
+ warning_code: {
7858
+ description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
7859
+ enum: ["unknown_issue_with_acs_access_group"],
7860
+ type: "string"
7861
+ }
7862
+ },
7863
+ required: ["created_at", "message", "warning_code"],
7864
+ type: "object"
7849
7865
  },
7850
- warning_code: {
7851
- description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
7852
- enum: ["unknown_issue_with_acs_access_group"],
7853
- type: "string"
7866
+ {
7867
+ description: "Indicates that the access group is being deleted from the access system. This is a temporary state, and the access group will be deleted shortly.",
7868
+ properties: {
7869
+ created_at: {
7870
+ description: "Date and time at which Seam created the warning.",
7871
+ format: "date-time",
7872
+ type: "string"
7873
+ },
7874
+ message: {
7875
+ description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
7876
+ type: "string"
7877
+ },
7878
+ warning_code: {
7879
+ description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
7880
+ enum: ["being_deleted"],
7881
+ type: "string"
7882
+ }
7883
+ },
7884
+ required: ["created_at", "message", "warning_code"],
7885
+ type: "object"
7854
7886
  }
7855
- },
7856
- required: ["created_at", "message", "warning_code"],
7857
- type: "object"
7887
+ ]
7858
7888
  },
7859
7889
  type: "array"
7860
7890
  },
@@ -14361,6 +14391,29 @@ var openapi_default = {
14361
14391
  type: "object",
14362
14392
  "x-route-path": "/connected_accounts"
14363
14393
  },
14394
+ customer: {
14395
+ description: "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.",
14396
+ properties: {
14397
+ created_at: {
14398
+ description: "Date and time at which the customer was created.",
14399
+ format: "date-time",
14400
+ type: "string"
14401
+ },
14402
+ customer_key: {
14403
+ description: "Unique key for the customer within the workspace.",
14404
+ type: "string"
14405
+ },
14406
+ workspace_id: {
14407
+ description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the customer.",
14408
+ format: "uuid",
14409
+ type: "string"
14410
+ }
14411
+ },
14412
+ required: ["customer_key", "workspace_id", "created_at"],
14413
+ type: "object",
14414
+ "x-route-path": "/customers",
14415
+ "x-undocumented": "Internal resource."
14416
+ },
14364
14417
  customization_profile: {
14365
14418
  description: "A customization profile.",
14366
14419
  properties: {
@@ -26886,24 +26939,50 @@ var openapi_default = {
26886
26939
  description: "Warnings associated with the `acs_access_group`.",
26887
26940
  items: {
26888
26941
  description: "Warning associated with the `acs_access_group`.",
26889
- properties: {
26890
- created_at: {
26891
- description: "Date and time at which Seam created the warning.",
26892
- format: "date-time",
26893
- type: "string"
26894
- },
26895
- message: {
26896
- description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
26897
- type: "string"
26942
+ oneOf: [
26943
+ {
26944
+ description: "An unknown issue occurred while syncing the state of this access group with the provider. This issue may affect the proper functioning of this access group.",
26945
+ properties: {
26946
+ created_at: {
26947
+ description: "Date and time at which Seam created the warning.",
26948
+ format: "date-time",
26949
+ type: "string"
26950
+ },
26951
+ message: {
26952
+ description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
26953
+ type: "string"
26954
+ },
26955
+ warning_code: {
26956
+ description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
26957
+ enum: ["unknown_issue_with_acs_access_group"],
26958
+ type: "string"
26959
+ }
26960
+ },
26961
+ required: ["created_at", "message", "warning_code"],
26962
+ type: "object"
26898
26963
  },
26899
- warning_code: {
26900
- description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
26901
- enum: ["unknown_issue_with_acs_access_group"],
26902
- type: "string"
26964
+ {
26965
+ description: "Indicates that the access group is being deleted from the access system. This is a temporary state, and the access group will be deleted shortly.",
26966
+ properties: {
26967
+ created_at: {
26968
+ description: "Date and time at which Seam created the warning.",
26969
+ format: "date-time",
26970
+ type: "string"
26971
+ },
26972
+ message: {
26973
+ description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
26974
+ type: "string"
26975
+ },
26976
+ warning_code: {
26977
+ description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
26978
+ enum: ["being_deleted"],
26979
+ type: "string"
26980
+ }
26981
+ },
26982
+ required: ["created_at", "message", "warning_code"],
26983
+ type: "object"
26903
26984
  }
26904
- },
26905
- required: ["created_at", "message", "warning_code"],
26906
- type: "object"
26985
+ ]
26907
26986
  },
26908
26987
  type: "array"
26909
26988
  },
@@ -35451,6 +35530,101 @@ var openapi_default = {
35451
35530
  "x-title": "Add an ACS User to an Access Group"
35452
35531
  }
35453
35532
  },
35533
+ "/acs/access_groups/delete": {
35534
+ delete: {
35535
+ description: "Deletes a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
35536
+ operationId: "acsAccessGroupsDeleteDelete",
35537
+ parameters: [
35538
+ {
35539
+ in: "query",
35540
+ name: "acs_access_group_id",
35541
+ required: true,
35542
+ schema: {
35543
+ description: "ID of the access group that you want to delete.",
35544
+ format: "uuid",
35545
+ type: "string"
35546
+ }
35547
+ }
35548
+ ],
35549
+ responses: {
35550
+ 200: {
35551
+ content: {
35552
+ "application/json": {
35553
+ schema: {
35554
+ properties: { ok: { type: "boolean" } },
35555
+ required: ["ok"],
35556
+ type: "object"
35557
+ }
35558
+ }
35559
+ },
35560
+ description: "OK"
35561
+ },
35562
+ 400: { description: "Bad Request" },
35563
+ 401: { description: "Unauthorized" }
35564
+ },
35565
+ security: [
35566
+ { client_session: [] },
35567
+ { pat_with_workspace: [] },
35568
+ { console_session_with_workspace: [] },
35569
+ { api_key: [] }
35570
+ ],
35571
+ summary: "/acs/access_groups/delete",
35572
+ tags: ["/acs"],
35573
+ "x-fern-sdk-group-name": ["acs", "access_groups"],
35574
+ "x-fern-sdk-method-name": "delete",
35575
+ "x-response-key": null,
35576
+ "x-title": "Delete an Access Group"
35577
+ },
35578
+ post: {
35579
+ description: "Deletes a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
35580
+ operationId: "acsAccessGroupsDeletePost",
35581
+ requestBody: {
35582
+ content: {
35583
+ "application/json": {
35584
+ schema: {
35585
+ properties: {
35586
+ acs_access_group_id: {
35587
+ description: "ID of the access group that you want to delete.",
35588
+ format: "uuid",
35589
+ type: "string"
35590
+ }
35591
+ },
35592
+ required: ["acs_access_group_id"],
35593
+ type: "object"
35594
+ }
35595
+ }
35596
+ }
35597
+ },
35598
+ responses: {
35599
+ 200: {
35600
+ content: {
35601
+ "application/json": {
35602
+ schema: {
35603
+ properties: { ok: { type: "boolean" } },
35604
+ required: ["ok"],
35605
+ type: "object"
35606
+ }
35607
+ }
35608
+ },
35609
+ description: "OK"
35610
+ },
35611
+ 400: { description: "Bad Request" },
35612
+ 401: { description: "Unauthorized" }
35613
+ },
35614
+ security: [
35615
+ { client_session: [] },
35616
+ { pat_with_workspace: [] },
35617
+ { console_session_with_workspace: [] },
35618
+ { api_key: [] }
35619
+ ],
35620
+ summary: "/acs/access_groups/delete",
35621
+ tags: ["/acs"],
35622
+ "x-fern-sdk-group-name": ["acs", "access_groups"],
35623
+ "x-fern-sdk-method-name": "delete",
35624
+ "x-response-key": null,
35625
+ "x-title": "Delete an Access Group"
35626
+ }
35627
+ },
35454
35628
  "/acs/access_groups/get": {
35455
35629
  get: {
35456
35630
  description: "Returns a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
@@ -56159,6 +56333,133 @@ var openapi_default = {
56159
56333
  "x-undocumented": "Internal endpoint for Console."
56160
56334
  }
56161
56335
  },
56336
+ "/seam/customer/v1/customers/list": {
56337
+ get: {
56338
+ description: "Returns a list of all customers within the workspace.",
56339
+ operationId: "seamCustomerV1CustomersListGet",
56340
+ parameters: [
56341
+ {
56342
+ in: "query",
56343
+ name: "limit",
56344
+ schema: {
56345
+ default: 500,
56346
+ description: "Maximum number of records to return per page.",
56347
+ exclusiveMinimum: true,
56348
+ minimum: 0,
56349
+ type: "integer"
56350
+ }
56351
+ },
56352
+ {
56353
+ in: "query",
56354
+ name: "page_cursor",
56355
+ schema: {
56356
+ description: "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
56357
+ nullable: true,
56358
+ type: "string"
56359
+ }
56360
+ }
56361
+ ],
56362
+ responses: {
56363
+ 200: {
56364
+ content: {
56365
+ "application/json": {
56366
+ schema: {
56367
+ properties: {
56368
+ customers: {
56369
+ items: { $ref: "#/components/schemas/customer" },
56370
+ type: "array"
56371
+ },
56372
+ ok: { type: "boolean" },
56373
+ pagination: { $ref: "#/components/schemas/pagination" }
56374
+ },
56375
+ required: ["customers", "pagination", "ok"],
56376
+ type: "object"
56377
+ }
56378
+ }
56379
+ },
56380
+ description: "OK"
56381
+ },
56382
+ 400: { description: "Bad Request" },
56383
+ 401: { description: "Unauthorized" }
56384
+ },
56385
+ security: [
56386
+ { api_key: [] },
56387
+ { pat_with_workspace: [] },
56388
+ { console_session_with_workspace: [] }
56389
+ ],
56390
+ summary: "/seam/customer/v1/customers/list",
56391
+ tags: [],
56392
+ "x-fern-sdk-group-name": ["seam", "customer", "v1", "customers"],
56393
+ "x-fern-sdk-method-name": "list",
56394
+ "x-fern-sdk-return-value": "customers",
56395
+ "x-response-key": "customers",
56396
+ "x-title": "List Customers",
56397
+ "x-undocumented": "Internal endpoint for Console."
56398
+ },
56399
+ post: {
56400
+ description: "Returns a list of all customers within the workspace.",
56401
+ operationId: "seamCustomerV1CustomersListPost",
56402
+ requestBody: {
56403
+ content: {
56404
+ "application/json": {
56405
+ schema: {
56406
+ properties: {
56407
+ limit: {
56408
+ default: 500,
56409
+ description: "Maximum number of records to return per page.",
56410
+ exclusiveMinimum: true,
56411
+ minimum: 0,
56412
+ type: "integer"
56413
+ },
56414
+ page_cursor: {
56415
+ description: "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
56416
+ nullable: true,
56417
+ type: "string"
56418
+ }
56419
+ },
56420
+ type: "object"
56421
+ }
56422
+ }
56423
+ }
56424
+ },
56425
+ responses: {
56426
+ 200: {
56427
+ content: {
56428
+ "application/json": {
56429
+ schema: {
56430
+ properties: {
56431
+ customers: {
56432
+ items: { $ref: "#/components/schemas/customer" },
56433
+ type: "array"
56434
+ },
56435
+ ok: { type: "boolean" },
56436
+ pagination: { $ref: "#/components/schemas/pagination" }
56437
+ },
56438
+ required: ["customers", "pagination", "ok"],
56439
+ type: "object"
56440
+ }
56441
+ }
56442
+ },
56443
+ description: "OK"
56444
+ },
56445
+ 400: { description: "Bad Request" },
56446
+ 401: { description: "Unauthorized" }
56447
+ },
56448
+ security: [
56449
+ { api_key: [] },
56450
+ { pat_with_workspace: [] },
56451
+ { console_session_with_workspace: [] }
56452
+ ],
56453
+ summary: "/seam/customer/v1/customers/list",
56454
+ tags: [],
56455
+ "x-fern-sdk-group-name": ["seam", "customer", "v1", "customers"],
56456
+ "x-fern-sdk-method-name": "list",
56457
+ "x-fern-sdk-return-value": "customers",
56458
+ "x-response-key": "customers",
56459
+ "x-title": "List Customers",
56460
+ "x-undocumented": "Internal endpoint for Console."
56461
+ }
56462
+ },
56162
56463
  "/seam/customer/v1/events/list": {
56163
56464
  get: {
56164
56465
  description: "Returns a list of events for devices in a specific space. This endpoint is designed for customer portals and only supports filtering by space_id.",