@seamapi/types 1.624.0 → 1.626.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.
@@ -43763,6 +43763,7 @@ declare const _default: {
43763
43763
  'x-fern-sdk-return-value': string;
43764
43764
  'x-response-key': string;
43765
43765
  'x-title': string;
43766
+ 'x-undocumented': string;
43766
43767
  };
43767
43768
  };
43768
43769
  '/seam/customer/v1/events/list': {
@@ -45703,6 +45704,7 @@ declare const _default: {
45703
45704
  'x-fern-sdk-return-value': string;
45704
45705
  'x-response-key': string;
45705
45706
  'x-title': string;
45707
+ 'x-undocumented': string;
45706
45708
  };
45707
45709
  };
45708
45710
  '/seam/customer/v1/spaces/list': {
@@ -45784,6 +45786,7 @@ declare const _default: {
45784
45786
  'x-fern-sdk-return-value': string;
45785
45787
  'x-response-key': string;
45786
45788
  'x-title': string;
45789
+ 'x-undocumented': string;
45787
45790
  };
45788
45791
  post: {
45789
45792
  description: string;
@@ -45856,6 +45859,224 @@ declare const _default: {
45856
45859
  'x-fern-sdk-return-value': string;
45857
45860
  'x-response-key': string;
45858
45861
  'x-title': string;
45862
+ 'x-undocumented': string;
45863
+ };
45864
+ };
45865
+ '/seam/customer/v1/staff_members/get': {
45866
+ get: {
45867
+ description: string;
45868
+ operationId: string;
45869
+ parameters: {
45870
+ in: string;
45871
+ name: string;
45872
+ required: boolean;
45873
+ schema: {
45874
+ description: string;
45875
+ type: string;
45876
+ };
45877
+ }[];
45878
+ responses: {
45879
+ 200: {
45880
+ content: {
45881
+ 'application/json': {
45882
+ schema: {
45883
+ properties: {
45884
+ access_grant: {
45885
+ $ref: string;
45886
+ };
45887
+ ok: {
45888
+ type: string;
45889
+ };
45890
+ spaces: {
45891
+ items: {
45892
+ properties: {
45893
+ child_space_keys: {
45894
+ items: {
45895
+ type: string;
45896
+ };
45897
+ type: string;
45898
+ };
45899
+ space_key: {
45900
+ type: string;
45901
+ };
45902
+ };
45903
+ required: string[];
45904
+ type: string;
45905
+ };
45906
+ type: string;
45907
+ };
45908
+ staff_member: {
45909
+ description: string;
45910
+ properties: {
45911
+ email_address: {
45912
+ description: string;
45913
+ type: string;
45914
+ };
45915
+ name: {
45916
+ description: string;
45917
+ type: string;
45918
+ };
45919
+ phone_number: {
45920
+ description: string;
45921
+ type: string;
45922
+ };
45923
+ space_keys: {
45924
+ description: string;
45925
+ items: {
45926
+ type: string;
45927
+ };
45928
+ type: string;
45929
+ };
45930
+ staff_member_key: {
45931
+ description: string;
45932
+ type: string;
45933
+ };
45934
+ user_identity_id: {
45935
+ format: string;
45936
+ type: string;
45937
+ };
45938
+ };
45939
+ required: string[];
45940
+ type: string;
45941
+ 'x-route-path': string;
45942
+ };
45943
+ };
45944
+ required: string[];
45945
+ type: string;
45946
+ };
45947
+ };
45948
+ };
45949
+ description: string;
45950
+ };
45951
+ 400: {
45952
+ description: string;
45953
+ };
45954
+ 401: {
45955
+ description: string;
45956
+ };
45957
+ };
45958
+ security: {
45959
+ client_session_with_customer: never[];
45960
+ }[];
45961
+ summary: string;
45962
+ tags: never[];
45963
+ 'x-fern-sdk-group-name': string[];
45964
+ 'x-fern-sdk-method-name': string;
45965
+ 'x-fern-sdk-return-value': string;
45966
+ 'x-response-key': string;
45967
+ 'x-title': string;
45968
+ 'x-undocumented': string;
45969
+ };
45970
+ post: {
45971
+ description: string;
45972
+ operationId: string;
45973
+ requestBody: {
45974
+ content: {
45975
+ 'application/json': {
45976
+ schema: {
45977
+ properties: {
45978
+ staff_member_key: {
45979
+ description: string;
45980
+ type: string;
45981
+ };
45982
+ };
45983
+ required: string[];
45984
+ type: string;
45985
+ };
45986
+ };
45987
+ };
45988
+ };
45989
+ responses: {
45990
+ 200: {
45991
+ content: {
45992
+ 'application/json': {
45993
+ schema: {
45994
+ properties: {
45995
+ access_grant: {
45996
+ $ref: string;
45997
+ };
45998
+ ok: {
45999
+ type: string;
46000
+ };
46001
+ spaces: {
46002
+ items: {
46003
+ properties: {
46004
+ child_space_keys: {
46005
+ items: {
46006
+ type: string;
46007
+ };
46008
+ type: string;
46009
+ };
46010
+ space_key: {
46011
+ type: string;
46012
+ };
46013
+ };
46014
+ required: string[];
46015
+ type: string;
46016
+ };
46017
+ type: string;
46018
+ };
46019
+ staff_member: {
46020
+ description: string;
46021
+ properties: {
46022
+ email_address: {
46023
+ description: string;
46024
+ type: string;
46025
+ };
46026
+ name: {
46027
+ description: string;
46028
+ type: string;
46029
+ };
46030
+ phone_number: {
46031
+ description: string;
46032
+ type: string;
46033
+ };
46034
+ space_keys: {
46035
+ description: string;
46036
+ items: {
46037
+ type: string;
46038
+ };
46039
+ type: string;
46040
+ };
46041
+ staff_member_key: {
46042
+ description: string;
46043
+ type: string;
46044
+ };
46045
+ user_identity_id: {
46046
+ format: string;
46047
+ type: string;
46048
+ };
46049
+ };
46050
+ required: string[];
46051
+ type: string;
46052
+ 'x-route-path': string;
46053
+ };
46054
+ };
46055
+ required: string[];
46056
+ type: string;
46057
+ };
46058
+ };
46059
+ };
46060
+ description: string;
46061
+ };
46062
+ 400: {
46063
+ description: string;
46064
+ };
46065
+ 401: {
46066
+ description: string;
46067
+ };
46068
+ };
46069
+ security: {
46070
+ client_session_with_customer: never[];
46071
+ }[];
46072
+ summary: string;
46073
+ tags: never[];
46074
+ 'x-fern-sdk-group-name': string[];
46075
+ 'x-fern-sdk-method-name': string;
46076
+ 'x-fern-sdk-return-value': string;
46077
+ 'x-response-key': string;
46078
+ 'x-title': string;
46079
+ 'x-undocumented': string;
45859
46080
  };
45860
46081
  };
45861
46082
  '/seam/customer/v1/staff_members/list': {
@@ -48576,6 +48576,7 @@ export default {
48576
48576
  'x-fern-sdk-return-value': 'connector_sync',
48577
48577
  'x-response-key': 'connector_sync',
48578
48578
  'x-title': 'Sync Connector Data',
48579
+ 'x-undocumented': 'Only used internally.',
48579
48580
  },
48580
48581
  },
48581
48582
  '/seam/customer/v1/events/list': {
@@ -50477,6 +50478,7 @@ export default {
50477
50478
  'x-fern-sdk-return-value': 'space',
50478
50479
  'x-response-key': 'space',
50479
50480
  'x-title': 'Create a Space',
50481
+ 'x-undocumented': 'Only used internally.',
50480
50482
  },
50481
50483
  },
50482
50484
  '/seam/customer/v1/spaces/list': {
@@ -50544,6 +50546,7 @@ export default {
50544
50546
  'x-fern-sdk-return-value': 'spaces',
50545
50547
  'x-response-key': 'spaces',
50546
50548
  'x-title': 'List Spaces',
50549
+ 'x-undocumented': 'Only used internally.',
50547
50550
  },
50548
50551
  post: {
50549
50552
  description: 'Returns a list of all spaces.',
@@ -50606,6 +50609,188 @@ export default {
50606
50609
  'x-fern-sdk-return-value': 'spaces',
50607
50610
  'x-response-key': 'spaces',
50608
50611
  'x-title': 'List Spaces',
50612
+ 'x-undocumented': 'Only used internally.',
50613
+ },
50614
+ },
50615
+ '/seam/customer/v1/staff_members/get': {
50616
+ get: {
50617
+ description: 'Returns a staff member for a specific customer.',
50618
+ operationId: 'seamCustomerV1StaffMembersGetGet',
50619
+ parameters: [
50620
+ {
50621
+ in: 'query',
50622
+ name: 'staff_member_key',
50623
+ required: true,
50624
+ schema: {
50625
+ description: 'Key of staff member to get.',
50626
+ type: 'string',
50627
+ },
50628
+ },
50629
+ ],
50630
+ responses: {
50631
+ 200: {
50632
+ content: {
50633
+ 'application/json': {
50634
+ schema: {
50635
+ properties: {
50636
+ access_grant: { $ref: '#/components/schemas/access_grant' },
50637
+ ok: { type: 'boolean' },
50638
+ spaces: {
50639
+ items: {
50640
+ properties: {
50641
+ child_space_keys: {
50642
+ items: { type: 'string' },
50643
+ type: 'array',
50644
+ },
50645
+ space_key: { type: 'string' },
50646
+ },
50647
+ required: ['space_key'],
50648
+ type: 'object',
50649
+ },
50650
+ type: 'array',
50651
+ },
50652
+ staff_member: {
50653
+ description: 'Represents a staff member for a specific customer.',
50654
+ properties: {
50655
+ email_address: {
50656
+ description: 'Email address associated with the user identity.',
50657
+ type: 'string',
50658
+ },
50659
+ name: {
50660
+ description: 'Your display name for this user identity resource.',
50661
+ type: 'string',
50662
+ },
50663
+ phone_number: {
50664
+ description: 'Phone number associated with the user identity.',
50665
+ type: 'string',
50666
+ },
50667
+ space_keys: {
50668
+ description: 'List of unique identifiers for the spaces the staff member is associated with.',
50669
+ items: { type: 'string' },
50670
+ type: 'array',
50671
+ },
50672
+ staff_member_key: {
50673
+ description: 'Your unique identifier for the staff.',
50674
+ type: 'string',
50675
+ },
50676
+ user_identity_id: { format: 'uuid', type: 'string' },
50677
+ },
50678
+ required: ['staff_member_key', 'name'],
50679
+ type: 'object',
50680
+ 'x-route-path': '/seam/customer/v1/staff_members',
50681
+ },
50682
+ },
50683
+ required: ['access_grant', 'spaces', 'staff_member', 'ok'],
50684
+ type: 'object',
50685
+ },
50686
+ },
50687
+ },
50688
+ description: 'OK',
50689
+ },
50690
+ 400: { description: 'Bad Request' },
50691
+ 401: { description: 'Unauthorized' },
50692
+ },
50693
+ security: [{ client_session_with_customer: [] }],
50694
+ summary: '/seam/customer/v1/staff_members/get',
50695
+ tags: [],
50696
+ 'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'staff_members'],
50697
+ 'x-fern-sdk-method-name': 'get',
50698
+ 'x-fern-sdk-return-value': 'staff_member',
50699
+ 'x-response-key': 'staff_member',
50700
+ 'x-title': 'Get Staff Member',
50701
+ 'x-undocumented': 'Internal endpoint for customer portals.',
50702
+ },
50703
+ post: {
50704
+ description: 'Returns a staff member for a specific customer.',
50705
+ operationId: 'seamCustomerV1StaffMembersGetPost',
50706
+ requestBody: {
50707
+ content: {
50708
+ 'application/json': {
50709
+ schema: {
50710
+ properties: {
50711
+ staff_member_key: {
50712
+ description: 'Key of staff member to get.',
50713
+ type: 'string',
50714
+ },
50715
+ },
50716
+ required: ['staff_member_key'],
50717
+ type: 'object',
50718
+ },
50719
+ },
50720
+ },
50721
+ },
50722
+ responses: {
50723
+ 200: {
50724
+ content: {
50725
+ 'application/json': {
50726
+ schema: {
50727
+ properties: {
50728
+ access_grant: { $ref: '#/components/schemas/access_grant' },
50729
+ ok: { type: 'boolean' },
50730
+ spaces: {
50731
+ items: {
50732
+ properties: {
50733
+ child_space_keys: {
50734
+ items: { type: 'string' },
50735
+ type: 'array',
50736
+ },
50737
+ space_key: { type: 'string' },
50738
+ },
50739
+ required: ['space_key'],
50740
+ type: 'object',
50741
+ },
50742
+ type: 'array',
50743
+ },
50744
+ staff_member: {
50745
+ description: 'Represents a staff member for a specific customer.',
50746
+ properties: {
50747
+ email_address: {
50748
+ description: 'Email address associated with the user identity.',
50749
+ type: 'string',
50750
+ },
50751
+ name: {
50752
+ description: 'Your display name for this user identity resource.',
50753
+ type: 'string',
50754
+ },
50755
+ phone_number: {
50756
+ description: 'Phone number associated with the user identity.',
50757
+ type: 'string',
50758
+ },
50759
+ space_keys: {
50760
+ description: 'List of unique identifiers for the spaces the staff member is associated with.',
50761
+ items: { type: 'string' },
50762
+ type: 'array',
50763
+ },
50764
+ staff_member_key: {
50765
+ description: 'Your unique identifier for the staff.',
50766
+ type: 'string',
50767
+ },
50768
+ user_identity_id: { format: 'uuid', type: 'string' },
50769
+ },
50770
+ required: ['staff_member_key', 'name'],
50771
+ type: 'object',
50772
+ 'x-route-path': '/seam/customer/v1/staff_members',
50773
+ },
50774
+ },
50775
+ required: ['access_grant', 'spaces', 'staff_member', 'ok'],
50776
+ type: 'object',
50777
+ },
50778
+ },
50779
+ },
50780
+ description: 'OK',
50781
+ },
50782
+ 400: { description: 'Bad Request' },
50783
+ 401: { description: 'Unauthorized' },
50784
+ },
50785
+ security: [{ client_session_with_customer: [] }],
50786
+ summary: '/seam/customer/v1/staff_members/get',
50787
+ tags: [],
50788
+ 'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'staff_members'],
50789
+ 'x-fern-sdk-method-name': 'get',
50790
+ 'x-fern-sdk-return-value': 'staff_member',
50791
+ 'x-response-key': 'staff_member',
50792
+ 'x-title': 'Get Staff Member',
50793
+ 'x-undocumented': 'Internal endpoint for customer portals.',
50609
50794
  },
50610
50795
  },
50611
50796
  '/seam/customer/v1/staff_members/list': {