@seamapi/types 1.558.0 → 1.560.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.
@@ -1145,35 +1145,6 @@ export default {
1145
1145
  ],
1146
1146
  type: 'object',
1147
1147
  },
1148
- {
1149
- description: 'Indicates that the credentials provided were invalid.',
1150
- properties: {
1151
- created_at: {
1152
- description: 'Date and time at which Seam created the error.',
1153
- format: 'date-time',
1154
- type: 'string',
1155
- },
1156
- error_code: {
1157
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
1158
- enum: ['invalid_credentials'],
1159
- type: 'string',
1160
- },
1161
- is_bridge_error: {
1162
- description: 'Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge).',
1163
- type: 'boolean',
1164
- },
1165
- is_connected_account_error: {
1166
- description: 'Indicates whether the error is related specifically to the connected account.',
1167
- type: 'boolean',
1168
- },
1169
- message: {
1170
- description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
1171
- type: 'string',
1172
- },
1173
- },
1174
- required: ['created_at', 'message', 'error_code'],
1175
- type: 'object',
1176
- },
1177
1148
  {
1178
1149
  description: 'Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).',
1179
1150
  properties: {
@@ -7952,35 +7923,6 @@ export default {
7952
7923
  required: ['created_at', 'message', 'error_code'],
7953
7924
  type: 'object',
7954
7925
  },
7955
- {
7956
- description: 'Indicates that the credentials provided were invalid.',
7957
- properties: {
7958
- created_at: {
7959
- description: 'Date and time at which Seam created the error.',
7960
- format: 'date-time',
7961
- type: 'string',
7962
- },
7963
- error_code: {
7964
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
7965
- enum: ['invalid_credentials'],
7966
- type: 'string',
7967
- },
7968
- is_bridge_error: {
7969
- description: 'Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge).',
7970
- type: 'boolean',
7971
- },
7972
- is_connected_account_error: {
7973
- description: 'Indicates whether the error is related specifically to the connected account.',
7974
- type: 'boolean',
7975
- },
7976
- message: {
7977
- description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
7978
- type: 'string',
7979
- },
7980
- },
7981
- required: ['created_at', 'message', 'error_code'],
7982
- type: 'object',
7983
- },
7984
7926
  {
7985
7927
  description: 'Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).',
7986
7928
  properties: {
@@ -8851,35 +8793,6 @@ export default {
8851
8793
  ],
8852
8794
  type: 'object',
8853
8795
  },
8854
- {
8855
- description: 'Indicates that the credentials provided were invalid.',
8856
- properties: {
8857
- created_at: {
8858
- description: 'Date and time at which Seam created the error.',
8859
- format: 'date-time',
8860
- type: 'string',
8861
- },
8862
- error_code: {
8863
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
8864
- enum: ['invalid_credentials'],
8865
- type: 'string',
8866
- },
8867
- is_bridge_error: {
8868
- description: 'Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge).',
8869
- type: 'boolean',
8870
- },
8871
- is_connected_account_error: {
8872
- description: 'Indicates whether the error is related specifically to the connected account.',
8873
- type: 'boolean',
8874
- },
8875
- message: {
8876
- description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
8877
- type: 'string',
8878
- },
8879
- },
8880
- required: ['created_at', 'message', 'error_code'],
8881
- type: 'object',
8882
- },
8883
8796
  {
8884
8797
  description: 'Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).',
8885
8798
  properties: {
@@ -19989,35 +19902,6 @@ export default {
19989
19902
  ],
19990
19903
  type: 'object',
19991
19904
  },
19992
- {
19993
- description: 'Indicates that the credentials provided were invalid.',
19994
- properties: {
19995
- created_at: {
19996
- description: 'Date and time at which Seam created the error.',
19997
- format: 'date-time',
19998
- type: 'string',
19999
- },
20000
- error_code: {
20001
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
20002
- enum: ['invalid_credentials'],
20003
- type: 'string',
20004
- },
20005
- is_bridge_error: {
20006
- description: 'Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge).',
20007
- type: 'boolean',
20008
- },
20009
- is_connected_account_error: {
20010
- description: 'Indicates whether the error is related specifically to the connected account.',
20011
- type: 'boolean',
20012
- },
20013
- message: {
20014
- description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
20015
- type: 'string',
20016
- },
20017
- },
20018
- required: ['created_at', 'message', 'error_code'],
20019
- type: 'object',
20020
- },
20021
19905
  {
20022
19906
  description: 'Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).',
20023
19907
  properties: {
@@ -22061,35 +21945,6 @@ export default {
22061
21945
  ],
22062
21946
  type: 'object',
22063
21947
  },
22064
- {
22065
- description: 'Indicates that the credentials provided were invalid.',
22066
- properties: {
22067
- created_at: {
22068
- description: 'Date and time at which Seam created the error.',
22069
- format: 'date-time',
22070
- type: 'string',
22071
- },
22072
- error_code: {
22073
- description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
22074
- enum: ['invalid_credentials'],
22075
- type: 'string',
22076
- },
22077
- is_bridge_error: {
22078
- description: 'Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge).',
22079
- type: 'boolean',
22080
- },
22081
- is_connected_account_error: {
22082
- description: 'Indicates whether the error is related specifically to the connected account.',
22083
- type: 'boolean',
22084
- },
22085
- message: {
22086
- description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
22087
- type: 'string',
22088
- },
22089
- },
22090
- required: ['created_at', 'message', 'error_code'],
22091
- type: 'object',
22092
- },
22093
21948
  {
22094
21949
  description: 'Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).',
22095
21950
  properties: {
@@ -46057,6 +45912,221 @@ export default {
46057
45912
  'x-undocumented': 'Internal endpoint for customer portals.',
46058
45913
  },
46059
45914
  },
45915
+ '/seam/customer/v1/reservations/list': {
45916
+ get: {
45917
+ description: 'Returns a list of reservations for a specific customer. This endpoint is designed for customer portals and supports filtering by space_key.',
45918
+ operationId: 'seamCustomerV1ReservationsListGet',
45919
+ parameters: [
45920
+ {
45921
+ in: 'query',
45922
+ name: 'space_key',
45923
+ schema: {
45924
+ description: 'Filter reservations by space key.',
45925
+ type: 'string',
45926
+ },
45927
+ },
45928
+ {
45929
+ in: 'query',
45930
+ name: 'limit',
45931
+ schema: {
45932
+ default: 500,
45933
+ description: 'Maximum number of records to return per page.',
45934
+ exclusiveMinimum: true,
45935
+ minimum: 0,
45936
+ type: 'integer',
45937
+ },
45938
+ },
45939
+ {
45940
+ in: 'query',
45941
+ name: 'created_before',
45942
+ schema: {
45943
+ description: 'Timestamp by which to limit returned reservations. Returns reservations created before this timestamp.',
45944
+ format: 'date-time',
45945
+ type: 'string',
45946
+ },
45947
+ },
45948
+ {
45949
+ in: 'query',
45950
+ name: 'page_cursor',
45951
+ schema: {
45952
+ description: "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
45953
+ nullable: true,
45954
+ type: 'string',
45955
+ },
45956
+ },
45957
+ ],
45958
+ responses: {
45959
+ 200: {
45960
+ content: {
45961
+ 'application/json': {
45962
+ schema: {
45963
+ properties: {
45964
+ ok: { type: 'boolean' },
45965
+ pagination: { $ref: '#/components/schemas/pagination' },
45966
+ reservations: {
45967
+ items: {
45968
+ properties: {
45969
+ access_methods: {
45970
+ items: {
45971
+ $ref: '#/components/schemas/access_method',
45972
+ },
45973
+ type: 'array',
45974
+ },
45975
+ created_at: { format: 'date-time', type: 'string' },
45976
+ ends_at: {
45977
+ format: 'date-time',
45978
+ nullable: true,
45979
+ type: 'string',
45980
+ },
45981
+ guest_name: { nullable: true, type: 'string' },
45982
+ name: { nullable: true, type: 'string' },
45983
+ reservation_id: { format: 'uuid', type: 'string' },
45984
+ reservation_key: { type: 'string' },
45985
+ starts_at: {
45986
+ format: 'date-time',
45987
+ nullable: true,
45988
+ type: 'string',
45989
+ },
45990
+ },
45991
+ required: [
45992
+ 'reservation_id',
45993
+ 'reservation_key',
45994
+ 'name',
45995
+ 'starts_at',
45996
+ 'ends_at',
45997
+ 'created_at',
45998
+ 'guest_name',
45999
+ 'access_methods',
46000
+ ],
46001
+ type: 'object',
46002
+ },
46003
+ type: 'array',
46004
+ },
46005
+ },
46006
+ required: ['reservations', 'pagination', 'ok'],
46007
+ type: 'object',
46008
+ },
46009
+ },
46010
+ },
46011
+ description: 'OK',
46012
+ },
46013
+ 400: { description: 'Bad Request' },
46014
+ 401: { description: 'Unauthorized' },
46015
+ },
46016
+ security: [{ client_session_with_customer: [] }],
46017
+ summary: '/seam/customer/v1/reservations/list',
46018
+ tags: [],
46019
+ 'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'reservations'],
46020
+ 'x-fern-sdk-method-name': 'list',
46021
+ 'x-fern-sdk-return-value': 'reservations',
46022
+ 'x-response-key': 'reservations',
46023
+ 'x-title': 'List Reservations for Customer Space',
46024
+ 'x-undocumented': 'Internal endpoint for customer portals.',
46025
+ },
46026
+ post: {
46027
+ description: 'Returns a list of reservations for a specific customer. This endpoint is designed for customer portals and supports filtering by space_key.',
46028
+ operationId: 'seamCustomerV1ReservationsListPost',
46029
+ requestBody: {
46030
+ content: {
46031
+ 'application/json': {
46032
+ schema: {
46033
+ properties: {
46034
+ created_before: {
46035
+ description: 'Timestamp by which to limit returned reservations. Returns reservations created before this timestamp.',
46036
+ format: 'date-time',
46037
+ type: 'string',
46038
+ },
46039
+ limit: {
46040
+ default: 500,
46041
+ description: 'Maximum number of records to return per page.',
46042
+ exclusiveMinimum: true,
46043
+ minimum: 0,
46044
+ type: 'integer',
46045
+ },
46046
+ page_cursor: {
46047
+ description: "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
46048
+ nullable: true,
46049
+ type: 'string',
46050
+ },
46051
+ space_key: {
46052
+ description: 'Filter reservations by space key.',
46053
+ type: 'string',
46054
+ },
46055
+ },
46056
+ type: 'object',
46057
+ },
46058
+ },
46059
+ },
46060
+ },
46061
+ responses: {
46062
+ 200: {
46063
+ content: {
46064
+ 'application/json': {
46065
+ schema: {
46066
+ properties: {
46067
+ ok: { type: 'boolean' },
46068
+ pagination: { $ref: '#/components/schemas/pagination' },
46069
+ reservations: {
46070
+ items: {
46071
+ properties: {
46072
+ access_methods: {
46073
+ items: {
46074
+ $ref: '#/components/schemas/access_method',
46075
+ },
46076
+ type: 'array',
46077
+ },
46078
+ created_at: { format: 'date-time', type: 'string' },
46079
+ ends_at: {
46080
+ format: 'date-time',
46081
+ nullable: true,
46082
+ type: 'string',
46083
+ },
46084
+ guest_name: { nullable: true, type: 'string' },
46085
+ name: { nullable: true, type: 'string' },
46086
+ reservation_id: { format: 'uuid', type: 'string' },
46087
+ reservation_key: { type: 'string' },
46088
+ starts_at: {
46089
+ format: 'date-time',
46090
+ nullable: true,
46091
+ type: 'string',
46092
+ },
46093
+ },
46094
+ required: [
46095
+ 'reservation_id',
46096
+ 'reservation_key',
46097
+ 'name',
46098
+ 'starts_at',
46099
+ 'ends_at',
46100
+ 'created_at',
46101
+ 'guest_name',
46102
+ 'access_methods',
46103
+ ],
46104
+ type: 'object',
46105
+ },
46106
+ type: 'array',
46107
+ },
46108
+ },
46109
+ required: ['reservations', 'pagination', 'ok'],
46110
+ type: 'object',
46111
+ },
46112
+ },
46113
+ },
46114
+ description: 'OK',
46115
+ },
46116
+ 400: { description: 'Bad Request' },
46117
+ 401: { description: 'Unauthorized' },
46118
+ },
46119
+ security: [{ client_session_with_customer: [] }],
46120
+ summary: '/seam/customer/v1/reservations/list',
46121
+ tags: [],
46122
+ 'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'reservations'],
46123
+ 'x-fern-sdk-method-name': 'list',
46124
+ 'x-fern-sdk-return-value': 'reservations',
46125
+ 'x-response-key': 'reservations',
46126
+ 'x-title': 'List Reservations for Customer Space',
46127
+ 'x-undocumented': 'Internal endpoint for customer portals.',
46128
+ },
46129
+ },
46060
46130
  '/seam/customer/v1/settings/get': {
46061
46131
  get: {
46062
46132
  description: 'Retrieves the settings for a customer portal workspace.',