@seamapi/types 1.592.0 → 1.593.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.
@@ -43587,6 +43587,159 @@ declare const _default: {
43587
43587
  'x-title': string;
43588
43588
  };
43589
43589
  };
43590
+ '/seam/customer/v1/spaces/list': {
43591
+ get: {
43592
+ description: string;
43593
+ operationId: string;
43594
+ parameters: ({
43595
+ in: string;
43596
+ name: string;
43597
+ schema: {
43598
+ description: string;
43599
+ minLength: number;
43600
+ type: string;
43601
+ format?: never;
43602
+ 'x-draft'?: never;
43603
+ 'x-undocumented'?: never;
43604
+ };
43605
+ } | {
43606
+ in: string;
43607
+ name: string;
43608
+ schema: {
43609
+ description: string;
43610
+ format: string;
43611
+ type: string;
43612
+ 'x-draft': string;
43613
+ 'x-undocumented': string;
43614
+ minLength?: never;
43615
+ };
43616
+ } | {
43617
+ in: string;
43618
+ name: string;
43619
+ schema: {
43620
+ description: string;
43621
+ type: string;
43622
+ minLength?: never;
43623
+ format?: never;
43624
+ 'x-draft'?: never;
43625
+ 'x-undocumented'?: never;
43626
+ };
43627
+ })[];
43628
+ responses: {
43629
+ 200: {
43630
+ content: {
43631
+ 'application/json': {
43632
+ schema: {
43633
+ properties: {
43634
+ ok: {
43635
+ type: string;
43636
+ };
43637
+ spaces: {
43638
+ items: {
43639
+ $ref: string;
43640
+ };
43641
+ type: string;
43642
+ };
43643
+ };
43644
+ required: string[];
43645
+ type: string;
43646
+ };
43647
+ };
43648
+ };
43649
+ description: string;
43650
+ };
43651
+ 400: {
43652
+ description: string;
43653
+ };
43654
+ 401: {
43655
+ description: string;
43656
+ };
43657
+ };
43658
+ security: {
43659
+ client_session_with_customer: never[];
43660
+ }[];
43661
+ summary: string;
43662
+ tags: never[];
43663
+ 'x-draft': string;
43664
+ 'x-fern-sdk-group-name': string[];
43665
+ 'x-fern-sdk-method-name': string;
43666
+ 'x-fern-sdk-return-value': string;
43667
+ 'x-response-key': string;
43668
+ 'x-title': string;
43669
+ };
43670
+ post: {
43671
+ description: string;
43672
+ operationId: string;
43673
+ requestBody: {
43674
+ content: {
43675
+ 'application/json': {
43676
+ schema: {
43677
+ properties: {
43678
+ connected_account_id: {
43679
+ description: string;
43680
+ format: string;
43681
+ type: string;
43682
+ 'x-draft': string;
43683
+ 'x-undocumented': string;
43684
+ };
43685
+ search: {
43686
+ description: string;
43687
+ minLength: number;
43688
+ type: string;
43689
+ };
43690
+ space_key: {
43691
+ description: string;
43692
+ type: string;
43693
+ };
43694
+ };
43695
+ type: string;
43696
+ };
43697
+ };
43698
+ };
43699
+ };
43700
+ responses: {
43701
+ 200: {
43702
+ content: {
43703
+ 'application/json': {
43704
+ schema: {
43705
+ properties: {
43706
+ ok: {
43707
+ type: string;
43708
+ };
43709
+ spaces: {
43710
+ items: {
43711
+ $ref: string;
43712
+ };
43713
+ type: string;
43714
+ };
43715
+ };
43716
+ required: string[];
43717
+ type: string;
43718
+ };
43719
+ };
43720
+ };
43721
+ description: string;
43722
+ };
43723
+ 400: {
43724
+ description: string;
43725
+ };
43726
+ 401: {
43727
+ description: string;
43728
+ };
43729
+ };
43730
+ security: {
43731
+ client_session_with_customer: never[];
43732
+ }[];
43733
+ summary: string;
43734
+ tags: never[];
43735
+ 'x-draft': string;
43736
+ 'x-fern-sdk-group-name': string[];
43737
+ 'x-fern-sdk-method-name': string;
43738
+ 'x-fern-sdk-return-value': string;
43739
+ 'x-response-key': string;
43740
+ 'x-title': string;
43741
+ };
43742
+ };
43590
43743
  '/seam/instant_key/v1/client_sessions/exchange_short_code': {
43591
43744
  post: {
43592
43745
  description: string;
@@ -48739,6 +48739,135 @@ export default {
48739
48739
  'x-title': 'Create a Space',
48740
48740
  },
48741
48741
  },
48742
+ '/seam/customer/v1/spaces/list': {
48743
+ get: {
48744
+ description: 'Returns a list of all spaces.',
48745
+ operationId: 'seamCustomerV1SpacesListGet',
48746
+ parameters: [
48747
+ {
48748
+ in: 'query',
48749
+ name: 'search',
48750
+ schema: {
48751
+ description: 'String for which to search. Filters returned spaces to include all records that satisfy a partial match using `name`.',
48752
+ minLength: 1,
48753
+ type: 'string',
48754
+ },
48755
+ },
48756
+ {
48757
+ in: 'query',
48758
+ name: 'connected_account_id',
48759
+ schema: {
48760
+ description: 'Filter spaces to only include those that contain devices or access control systems belonging to the specified connected account.',
48761
+ format: 'uuid',
48762
+ type: 'string',
48763
+ 'x-draft': 'Needs review.',
48764
+ 'x-undocumented': 'Only used internally.',
48765
+ },
48766
+ },
48767
+ {
48768
+ in: 'query',
48769
+ name: 'space_key',
48770
+ schema: {
48771
+ description: 'Filter spaces by space_key.',
48772
+ type: 'string',
48773
+ },
48774
+ },
48775
+ ],
48776
+ responses: {
48777
+ 200: {
48778
+ content: {
48779
+ 'application/json': {
48780
+ schema: {
48781
+ properties: {
48782
+ ok: { type: 'boolean' },
48783
+ spaces: {
48784
+ items: { $ref: '#/components/schemas/space' },
48785
+ type: 'array',
48786
+ },
48787
+ },
48788
+ required: ['spaces', 'ok'],
48789
+ type: 'object',
48790
+ },
48791
+ },
48792
+ },
48793
+ description: 'OK',
48794
+ },
48795
+ 400: { description: 'Bad Request' },
48796
+ 401: { description: 'Unauthorized' },
48797
+ },
48798
+ security: [{ client_session_with_customer: [] }],
48799
+ summary: '/seam/customer/v1/spaces/list',
48800
+ tags: [],
48801
+ 'x-draft': 'Early access.',
48802
+ 'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'spaces'],
48803
+ 'x-fern-sdk-method-name': 'list',
48804
+ 'x-fern-sdk-return-value': 'spaces',
48805
+ 'x-response-key': 'spaces',
48806
+ 'x-title': 'List Spaces',
48807
+ },
48808
+ post: {
48809
+ description: 'Returns a list of all spaces.',
48810
+ operationId: 'seamCustomerV1SpacesListPost',
48811
+ requestBody: {
48812
+ content: {
48813
+ 'application/json': {
48814
+ schema: {
48815
+ properties: {
48816
+ connected_account_id: {
48817
+ description: 'Filter spaces to only include those that contain devices or access control systems belonging to the specified connected account.',
48818
+ format: 'uuid',
48819
+ type: 'string',
48820
+ 'x-draft': 'Needs review.',
48821
+ 'x-undocumented': 'Only used internally.',
48822
+ },
48823
+ search: {
48824
+ description: 'String for which to search. Filters returned spaces to include all records that satisfy a partial match using `name`.',
48825
+ minLength: 1,
48826
+ type: 'string',
48827
+ },
48828
+ space_key: {
48829
+ description: 'Filter spaces by space_key.',
48830
+ type: 'string',
48831
+ },
48832
+ },
48833
+ type: 'object',
48834
+ },
48835
+ },
48836
+ },
48837
+ },
48838
+ responses: {
48839
+ 200: {
48840
+ content: {
48841
+ 'application/json': {
48842
+ schema: {
48843
+ properties: {
48844
+ ok: { type: 'boolean' },
48845
+ spaces: {
48846
+ items: { $ref: '#/components/schemas/space' },
48847
+ type: 'array',
48848
+ },
48849
+ },
48850
+ required: ['spaces', 'ok'],
48851
+ type: 'object',
48852
+ },
48853
+ },
48854
+ },
48855
+ description: 'OK',
48856
+ },
48857
+ 400: { description: 'Bad Request' },
48858
+ 401: { description: 'Unauthorized' },
48859
+ },
48860
+ security: [{ client_session_with_customer: [] }],
48861
+ summary: '/seam/customer/v1/spaces/list',
48862
+ tags: [],
48863
+ 'x-draft': 'Early access.',
48864
+ 'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'spaces'],
48865
+ 'x-fern-sdk-method-name': 'list',
48866
+ 'x-fern-sdk-return-value': 'spaces',
48867
+ 'x-response-key': 'spaces',
48868
+ 'x-title': 'List Spaces',
48869
+ },
48870
+ },
48742
48871
  '/seam/instant_key/v1/client_sessions/exchange_short_code': {
48743
48872
  post: {
48744
48873
  description: 'Exchanges a short code for a client session token. Mobile apps use this endpoint to retrieve a client session token securely using a short code obtained from an Instant Key URL.',