@rocket.chat/rest-typings 9.0.0-rc.0 → 9.0.0-rc.1
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/README.md +211 -79
- package/dist/apps/appLogsExportProps.d.ts +1 -1
- package/dist/apps/appLogsExportProps.d.ts.map +1 -1
- package/dist/default/index.d.ts +2 -0
- package/dist/default/index.d.ts.map +1 -1
- package/dist/experimental/index.d.ts +35 -0
- package/dist/experimental/index.d.ts.map +1 -0
- package/dist/experimental/index.js +2 -0
- package/dist/experimental/index.js.map +1 -0
- package/dist/helpers/PaginatedRequest.d.ts +0 -1
- package/dist/helpers/PaginatedRequest.d.ts.map +1 -1
- package/dist/index.d.ts +7 -2
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +3 -1
- package/dist/index.js.map +1 -1
- package/dist/v1/Ajv.d.ts +5 -5
- package/dist/v1/Ajv.d.ts.map +1 -1
- package/dist/v1/Ajv.js +44 -3
- package/dist/v1/Ajv.js.map +1 -1
- package/dist/v1/abacCreationAttributes.d.ts +22 -0
- package/dist/v1/abacCreationAttributes.d.ts.map +1 -0
- package/dist/v1/abacCreationAttributes.js +15 -0
- package/dist/v1/abacCreationAttributes.js.map +1 -0
- package/dist/v1/aiSearch.d.ts +1 -0
- package/dist/v1/aiSearch.d.ts.map +1 -1
- package/dist/v1/aiSearch.js +1 -0
- package/dist/v1/aiSearch.js.map +1 -1
- package/dist/v1/banners.d.ts +3 -0
- package/dist/v1/banners.d.ts.map +1 -1
- package/dist/v1/banners.js +17 -0
- package/dist/v1/banners.js.map +1 -1
- package/dist/v1/channels/ChannelsConvertToTeamProps.d.ts.map +1 -1
- package/dist/v1/channels/ChannelsConvertToTeamProps.js.map +1 -1
- package/dist/v1/channels/ChannelsCreateProps.d.ts +4 -0
- package/dist/v1/channels/ChannelsCreateProps.d.ts.map +1 -1
- package/dist/v1/channels/ChannelsCreateProps.js +21 -2
- package/dist/v1/channels/ChannelsCreateProps.js.map +1 -1
- package/dist/v1/channels/ChannelsFilesListProps.d.ts +0 -1
- package/dist/v1/channels/ChannelsFilesListProps.d.ts.map +1 -1
- package/dist/v1/channels/ChannelsFilesListProps.js +8 -26
- package/dist/v1/channels/ChannelsFilesListProps.js.map +1 -1
- package/dist/v1/channels/ChannelsGetAllUserMentionsByChannelProps.d.ts.map +1 -1
- package/dist/v1/channels/ChannelsGetAllUserMentionsByChannelProps.js +4 -18
- package/dist/v1/channels/ChannelsGetAllUserMentionsByChannelProps.js.map +1 -1
- package/dist/v1/channels/ChannelsGetIntegrationsProps.d.ts.map +1 -1
- package/dist/v1/channels/ChannelsGetIntegrationsProps.js.map +1 -1
- package/dist/v1/channels/ChannelsHistoryProps.d.ts.map +1 -1
- package/dist/v1/channels/ChannelsHistoryProps.js +17 -48
- package/dist/v1/channels/ChannelsHistoryProps.js.map +1 -1
- package/dist/v1/channels/ChannelsInviteProps.d.ts +9 -6
- package/dist/v1/channels/ChannelsInviteProps.d.ts.map +1 -1
- package/dist/v1/channels/ChannelsInviteProps.js +32 -32
- package/dist/v1/channels/ChannelsInviteProps.js.map +1 -1
- package/dist/v1/channels/ChannelsListProps.d.ts.map +1 -1
- package/dist/v1/channels/ChannelsListProps.js +4 -15
- package/dist/v1/channels/ChannelsListProps.js.map +1 -1
- package/dist/v1/channels/ChannelsMessagesProps.d.ts +1 -2
- package/dist/v1/channels/ChannelsMessagesProps.d.ts.map +1 -1
- package/dist/v1/channels/ChannelsMessagesProps.js +7 -23
- package/dist/v1/channels/ChannelsMessagesProps.js.map +1 -1
- package/dist/v1/channels/ChannelsOnlineProps.d.ts +1 -2
- package/dist/v1/channels/ChannelsOnlineProps.d.ts.map +1 -1
- package/dist/v1/channels/ChannelsOnlineProps.js +1 -6
- package/dist/v1/channels/ChannelsOnlineProps.js.map +1 -1
- package/dist/v1/channels/ChannelsOpenProps.d.ts +0 -2
- package/dist/v1/channels/ChannelsOpenProps.d.ts.map +1 -1
- package/dist/v1/channels/ChannelsOpenProps.js +0 -8
- package/dist/v1/channels/ChannelsOpenProps.js.map +1 -1
- package/dist/v1/channels/ChannelsSetCustomFieldsProps.d.ts.map +1 -1
- package/dist/v1/channels/ChannelsSetCustomFieldsProps.js.map +1 -1
- package/dist/v1/channels/channels.d.ts +5 -3
- package/dist/v1/channels/channels.d.ts.map +1 -1
- package/dist/v1/chat.d.ts +116 -62
- package/dist/v1/chat.d.ts.map +1 -1
- package/dist/v1/chat.js +126 -139
- package/dist/v1/chat.js.map +1 -1
- package/dist/v1/cloud.d.ts +5 -0
- package/dist/v1/cloud.d.ts.map +1 -1
- package/dist/v1/customSounds.d.ts.map +1 -1
- package/dist/v1/customSounds.js +4 -18
- package/dist/v1/customSounds.js.map +1 -1
- package/dist/v1/directory.d.ts +0 -1
- package/dist/v1/directory.d.ts.map +1 -1
- package/dist/v1/directory.js +6 -22
- package/dist/v1/directory.js.map +1 -1
- package/dist/v1/dm/DmFileProps.d.ts +0 -1
- package/dist/v1/dm/DmFileProps.d.ts.map +1 -1
- package/dist/v1/dm/DmFileProps.js +8 -26
- package/dist/v1/dm/DmFileProps.js.map +1 -1
- package/dist/v1/dm/DmHistoryProps.d.ts.map +1 -1
- package/dist/v1/dm/DmHistoryProps.js +9 -22
- package/dist/v1/dm/DmHistoryProps.js.map +1 -1
- package/dist/v1/dm/DmMembersProps.d.ts.map +1 -1
- package/dist/v1/dm/DmMembersProps.js +11 -38
- package/dist/v1/dm/DmMembersProps.js.map +1 -1
- package/dist/v1/dm/DmMessagesProps.d.ts +0 -2
- package/dist/v1/dm/DmMessagesProps.d.ts.map +1 -1
- package/dist/v1/dm/DmMessagesProps.js +13 -48
- package/dist/v1/dm/DmMessagesProps.js.map +1 -1
- package/dist/v1/dm/dm.d.ts +7 -3
- package/dist/v1/dm/dm.d.ts.map +1 -1
- package/dist/v1/dm/im.d.ts +62 -45
- package/dist/v1/dm/im.d.ts.map +1 -1
- package/dist/v1/dm/index.d.ts +1 -0
- package/dist/v1/dm/index.d.ts.map +1 -1
- package/dist/v1/dm/index.js +1 -0
- package/dist/v1/dm/index.js.map +1 -1
- package/dist/v1/e2e.d.ts +68 -3
- package/dist/v1/e2e.d.ts.map +1 -1
- package/dist/v1/e2e.js.map +1 -1
- package/dist/v1/email-inbox.d.ts +5 -3
- package/dist/v1/email-inbox.d.ts.map +1 -1
- package/dist/v1/email-inbox.js +3 -16
- package/dist/v1/email-inbox.js.map +1 -1
- package/dist/v1/emojiCustom.d.ts +19 -14
- package/dist/v1/emojiCustom.d.ts.map +1 -1
- package/dist/v1/emojiCustom.js +0 -3
- package/dist/v1/emojiCustom.js.map +1 -1
- package/dist/v1/federation/index.d.ts +10 -16
- package/dist/v1/federation/index.d.ts.map +1 -1
- package/dist/v1/federation/index.js +1 -5
- package/dist/v1/federation/index.js.map +1 -1
- package/dist/v1/groups/BaseProps.d.ts.map +1 -1
- package/dist/v1/groups/BaseProps.js.map +1 -1
- package/dist/v1/groups/GroupsCreateProps.d.ts +5 -0
- package/dist/v1/groups/GroupsCreateProps.d.ts.map +1 -1
- package/dist/v1/groups/GroupsCreateProps.js +10 -0
- package/dist/v1/groups/GroupsCreateProps.js.map +1 -1
- package/dist/v1/groups/GroupsFilesProps.d.ts.map +1 -1
- package/dist/v1/groups/GroupsFilesProps.js +8 -26
- package/dist/v1/groups/GroupsFilesProps.js.map +1 -1
- package/dist/v1/groups/GroupsMessagesProps.d.ts +0 -1
- package/dist/v1/groups/GroupsMessagesProps.d.ts.map +1 -1
- package/dist/v1/groups/GroupsMessagesProps.js +0 -4
- package/dist/v1/groups/GroupsMessagesProps.js.map +1 -1
- package/dist/v1/groups/GroupsOnlineProps.d.ts +1 -2
- package/dist/v1/groups/GroupsOnlineProps.d.ts.map +1 -1
- package/dist/v1/groups/GroupsOnlineProps.js +1 -6
- package/dist/v1/groups/GroupsOnlineProps.js.map +1 -1
- package/dist/v1/groups/groups.d.ts +1 -0
- package/dist/v1/groups/groups.d.ts.map +1 -1
- package/dist/v1/integrations/IntegrationsHistoryProps.d.ts.map +1 -1
- package/dist/v1/integrations/IntegrationsHistoryProps.js +2 -7
- package/dist/v1/integrations/IntegrationsHistoryProps.js.map +1 -1
- package/dist/v1/integrations/IntegrationsListProps.d.ts +0 -1
- package/dist/v1/integrations/IntegrationsListProps.d.ts.map +1 -1
- package/dist/v1/integrations/IntegrationsListProps.js +5 -20
- package/dist/v1/integrations/IntegrationsListProps.js.map +1 -1
- package/dist/v1/integrations/IntegrationsRemoveProps.d.ts.map +1 -1
- package/dist/v1/integrations/IntegrationsRemoveProps.js.map +1 -1
- package/dist/v1/invites.d.ts +8 -4
- package/dist/v1/invites.d.ts.map +1 -1
- package/dist/v1/me/meSuccessResponse.d.ts +1 -1
- package/dist/v1/me/meSuccessResponse.d.ts.map +1 -1
- package/dist/v1/misc.d.ts.map +1 -1
- package/dist/v1/misc.js +6 -22
- package/dist/v1/misc.js.map +1 -1
- package/dist/v1/moderation/GetUserReportsParams.d.ts.map +1 -1
- package/dist/v1/moderation/GetUserReportsParams.js +5 -16
- package/dist/v1/moderation/GetUserReportsParams.js.map +1 -1
- package/dist/v1/moderation/ReportHistoryProps.d.ts.map +1 -1
- package/dist/v1/moderation/ReportHistoryProps.js +6 -18
- package/dist/v1/moderation/ReportHistoryProps.js.map +1 -1
- package/dist/v1/moderation/ReportsByMsgIdParams.d.ts.map +1 -1
- package/dist/v1/moderation/ReportsByMsgIdParams.js +5 -16
- package/dist/v1/moderation/ReportsByMsgIdParams.js.map +1 -1
- package/dist/v1/omnichannel.d.ts +3 -11
- package/dist/v1/omnichannel.d.ts.map +1 -1
- package/dist/v1/omnichannel.js +177 -712
- package/dist/v1/omnichannel.js.map +1 -1
- package/dist/v1/pagination.d.ts +39 -0
- package/dist/v1/pagination.d.ts.map +1 -0
- package/dist/v1/pagination.js +41 -0
- package/dist/v1/pagination.js.map +1 -0
- package/dist/v1/push.d.ts +1 -2
- package/dist/v1/push.d.ts.map +1 -1
- package/dist/v1/roles.d.ts +4 -4
- package/dist/v1/roles.d.ts.map +1 -1
- package/dist/v1/roles.js +5 -20
- package/dist/v1/roles.js.map +1 -1
- package/dist/v1/rooms.d.ts +107 -19
- package/dist/v1/rooms.d.ts.map +1 -1
- package/dist/v1/rooms.js +60 -78
- package/dist/v1/rooms.js.map +1 -1
- package/dist/v1/saml.d.ts +16 -0
- package/dist/v1/saml.d.ts.map +1 -0
- package/dist/v1/saml.js +28 -0
- package/dist/v1/saml.js.map +1 -0
- package/dist/v1/server-events/ServerEventsAuditSettingsParamsGET.d.ts.map +1 -1
- package/dist/v1/server-events/ServerEventsAuditSettingsParamsGET.js +7 -20
- package/dist/v1/server-events/ServerEventsAuditSettingsParamsGET.js.map +1 -1
- package/dist/v1/settings.d.ts +8 -2
- package/dist/v1/settings.d.ts.map +1 -1
- package/dist/v1/settings.js +7 -35
- package/dist/v1/settings.js.map +1 -1
- package/dist/v1/setupWizard.d.ts +10 -0
- package/dist/v1/setupWizard.d.ts.map +1 -0
- package/dist/v1/setupWizard.js +2 -0
- package/dist/v1/setupWizard.js.map +1 -0
- package/dist/v1/statistics.d.ts +5 -3
- package/dist/v1/statistics.d.ts.map +1 -1
- package/dist/v1/statistics.js +3 -20
- package/dist/v1/statistics.js.map +1 -1
- package/dist/v1/teams/TeamsCreateProps.d.ts +2 -0
- package/dist/v1/teams/TeamsCreateProps.d.ts.map +1 -1
- package/dist/v1/teams/TeamsCreateProps.js +2 -0
- package/dist/v1/teams/TeamsCreateProps.js.map +1 -1
- package/dist/v1/teams/TeamsListChildren.d.ts.map +1 -1
- package/dist/v1/teams/TeamsListChildren.js +2 -10
- package/dist/v1/teams/TeamsListChildren.js.map +1 -1
- package/dist/v1/teams/TeamsListRoomsOfUserProps.d.ts.map +1 -1
- package/dist/v1/teams/TeamsListRoomsOfUserProps.js +2 -9
- package/dist/v1/teams/TeamsListRoomsOfUserProps.js.map +1 -1
- package/dist/v1/teams/TeamsListRoomsProps.d.ts.map +1 -1
- package/dist/v1/teams/TeamsListRoomsProps.js +2 -9
- package/dist/v1/teams/TeamsListRoomsProps.js.map +1 -1
- package/dist/v1/teams/TeamsMembersProps.d.ts.map +1 -1
- package/dist/v1/teams/TeamsMembersProps.js +2 -10
- package/dist/v1/teams/TeamsMembersProps.js.map +1 -1
- package/dist/v1/teams/TeamsRemoveRoomProps.d.ts +2 -2
- package/dist/v1/teams/TeamsRemoveRoomProps.d.ts.map +1 -1
- package/dist/v1/teams/index.d.ts +15 -41
- package/dist/v1/teams/index.d.ts.map +1 -1
- package/dist/v1/teams/index.js.map +1 -1
- package/dist/v1/users/UserCreateParamsPOST.d.ts +4 -3
- package/dist/v1/users/UserCreateParamsPOST.d.ts.map +1 -1
- package/dist/v1/users/UserCreateParamsPOST.js +4 -2
- package/dist/v1/users/UserCreateParamsPOST.js.map +1 -1
- package/dist/v1/users/UsersInfoParamsGet.d.ts +1 -2
- package/dist/v1/users/UsersInfoParamsGet.d.ts.map +1 -1
- package/dist/v1/users/UsersInfoParamsGet.js +17 -22
- package/dist/v1/users/UsersInfoParamsGet.js.map +1 -1
- package/dist/v1/users/UsersListParamsGET.d.ts +3 -2
- package/dist/v1/users/UsersListParamsGET.d.ts.map +1 -1
- package/dist/v1/users/UsersListParamsGET.js +2 -8
- package/dist/v1/users/UsersListParamsGET.js.map +1 -1
- package/dist/v1/users/UsersListStatusParamsGET.d.ts +1 -0
- package/dist/v1/users/UsersListStatusParamsGET.d.ts.map +1 -1
- package/dist/v1/users/UsersListStatusParamsGET.js +12 -24
- package/dist/v1/users/UsersListStatusParamsGET.js.map +1 -1
- package/dist/v1/users/UsersListStatusVisibilityParamsGET.d.ts +7 -0
- package/dist/v1/users/UsersListStatusVisibilityParamsGET.d.ts.map +1 -0
- package/dist/v1/users/UsersListStatusVisibilityParamsGET.js +12 -0
- package/dist/v1/users/UsersListStatusVisibilityParamsGET.js.map +1 -0
- package/dist/v1/users/UsersPresenceParamsGET.d.ts +1 -2
- package/dist/v1/users/UsersPresenceParamsGET.d.ts.map +1 -1
- package/dist/v1/users/UsersRequestDataDownloadParamsGET.d.ts +2 -3
- package/dist/v1/users/UsersRequestDataDownloadParamsGET.d.ts.map +1 -1
- package/dist/v1/users/UsersRequestDataDownloadParamsGET.js +1 -1
- package/dist/v1/users/UsersRequestDataDownloadParamsGET.js.map +1 -1
- package/dist/v1/users/UsersSetPreferenceParamsPOST.d.ts +3 -1
- package/dist/v1/users/UsersSetPreferenceParamsPOST.d.ts.map +1 -1
- package/dist/v1/users/UsersSetPreferenceParamsPOST.js +19 -0
- package/dist/v1/users/UsersSetPreferenceParamsPOST.js.map +1 -1
- package/dist/v1/users/UsersUpdateOwnBasicInfoParamsPOST.d.ts +2 -0
- package/dist/v1/users/UsersUpdateOwnBasicInfoParamsPOST.d.ts.map +1 -1
- package/dist/v1/users/UsersUpdateOwnBasicInfoParamsPOST.js +2 -0
- package/dist/v1/users/UsersUpdateOwnBasicInfoParamsPOST.js.map +1 -1
- package/dist/v1/users/UsersUpdateParamsPOST.d.ts +5 -2
- package/dist/v1/users/UsersUpdateParamsPOST.d.ts.map +1 -1
- package/dist/v1/users/UsersUpdateParamsPOST.js +12 -1
- package/dist/v1/users/UsersUpdateParamsPOST.js.map +1 -1
- package/dist/v1/users/phonesSchema.d.ts +22 -0
- package/dist/v1/users/phonesSchema.d.ts.map +1 -0
- package/dist/v1/users/phonesSchema.js +15 -0
- package/dist/v1/users/phonesSchema.js.map +1 -0
- package/dist/v1/users.d.ts +48 -9
- package/dist/v1/users.d.ts.map +1 -1
- package/dist/v1/users.js +1 -0
- package/dist/v1/users.js.map +1 -1
- package/dist/v1/videoConference/VideoConfAddParticipantsProps.d.ts +18 -0
- package/dist/v1/videoConference/VideoConfAddParticipantsProps.d.ts.map +1 -0
- package/dist/v1/videoConference/VideoConfAddParticipantsProps.js +30 -0
- package/dist/v1/videoConference/VideoConfAddParticipantsProps.js.map +1 -0
- package/dist/v1/videoConference/VideoConfCallIdProps.d.ts +11 -0
- package/dist/v1/videoConference/VideoConfCallIdProps.d.ts.map +1 -0
- package/dist/v1/videoConference/{VideoConfCancelProps.js → VideoConfCallIdProps.js} +3 -3
- package/dist/v1/videoConference/{VideoConfCancelProps.js.map → VideoConfCallIdProps.js.map} +1 -1
- package/dist/v1/videoConference/VideoConfListProps.d.ts.map +1 -1
- package/dist/v1/videoConference/VideoConfListProps.js +3 -6
- package/dist/v1/videoConference/VideoConfListProps.js.map +1 -1
- package/dist/v1/videoConference/VideoConfRenameProps.d.ts +7 -0
- package/dist/v1/videoConference/VideoConfRenameProps.d.ts.map +1 -0
- package/dist/v1/videoConference/VideoConfRenameProps.js +20 -0
- package/dist/v1/videoConference/VideoConfRenameProps.js.map +1 -0
- package/dist/v1/videoConference/VideoConfRingProps.d.ts +11 -0
- package/dist/v1/videoConference/VideoConfRingProps.d.ts.map +1 -0
- package/dist/v1/videoConference/VideoConfRingProps.js +19 -0
- package/dist/v1/videoConference/VideoConfRingProps.js.map +1 -0
- package/dist/v1/videoConference/VideoConfShareChatProps.d.ts +12 -0
- package/dist/v1/videoConference/VideoConfShareChatProps.d.ts.map +1 -0
- package/dist/v1/videoConference/VideoConfShareChatProps.js +18 -0
- package/dist/v1/videoConference/VideoConfShareChatProps.js.map +1 -0
- package/dist/v1/videoConference/index.d.ts +72 -4
- package/dist/v1/videoConference/index.d.ts.map +1 -1
- package/dist/v1/videoConference/index.js +5 -1
- package/dist/v1/videoConference/index.js.map +1 -1
- package/package.json +16 -10
- package/dist/v1/federation/FederationAddServerProps.d.ts +0 -5
- package/dist/v1/federation/FederationAddServerProps.d.ts.map +0 -1
- package/dist/v1/federation/FederationAddServerProps.js +0 -13
- package/dist/v1/federation/FederationAddServerProps.js.map +0 -1
- package/dist/v1/federation/FederationJoinExternalPublicRoomProps.d.ts +0 -7
- package/dist/v1/federation/FederationJoinExternalPublicRoomProps.d.ts.map +0 -1
- package/dist/v1/federation/FederationJoinExternalPublicRoomProps.js +0 -23
- package/dist/v1/federation/FederationJoinExternalPublicRoomProps.js.map +0 -1
- package/dist/v1/federation/FederationPublicRoomsProps.d.ts +0 -7
- package/dist/v1/federation/FederationPublicRoomsProps.d.ts.map +0 -1
- package/dist/v1/federation/FederationPublicRoomsProps.js +0 -25
- package/dist/v1/federation/FederationPublicRoomsProps.js.map +0 -1
- package/dist/v1/federation/FederationRemoveServerProps.d.ts +0 -5
- package/dist/v1/federation/FederationRemoveServerProps.d.ts.map +0 -1
- package/dist/v1/federation/FederationRemoveServerProps.js +0 -13
- package/dist/v1/federation/FederationRemoveServerProps.js.map +0 -1
- package/dist/v1/federation/FederationVerifyMatrixIdProps.d.ts +0 -5
- package/dist/v1/federation/FederationVerifyMatrixIdProps.d.ts.map +0 -1
- package/dist/v1/federation/FederationVerifyMatrixIdProps.js +0 -17
- package/dist/v1/federation/FederationVerifyMatrixIdProps.js.map +0 -1
- package/dist/v1/federation/rooms.d.ts +0 -44
- package/dist/v1/federation/rooms.d.ts.map +0 -1
- package/dist/v1/federation/rooms.js +0 -2
- package/dist/v1/federation/rooms.js.map +0 -1
- package/dist/v1/videoConference/VideoConfCancelProps.d.ts +0 -5
- package/dist/v1/videoConference/VideoConfCancelProps.d.ts.map +0 -1
package/README.md
CHANGED
|
@@ -1,85 +1,217 @@
|
|
|
1
|
+
# `@rocket.chat/rest-typings`
|
|
1
2
|
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
### Good examples of what not to do:
|
|
18
|
-
|
|
19
|
-
#### If you have an endpoint that accepts name or id, both are not optional, one of them is required
|
|
20
|
-
|
|
21
|
-
```typescript
|
|
22
|
-
|
|
23
|
-
type EndPointTestGetParams = { name?: string; id?: string; } // WRONG!
|
|
24
|
-
|
|
25
|
-
type EndPointTestGetParams = { name: string; } | { id: string; } // Better :)
|
|
26
|
-
````
|
|
27
|
-
|
|
28
|
-
#### If you have an endpoint that accepts name or id, both are not optional, one of them is required
|
|
29
|
-
|
|
30
|
-
```typescript
|
|
31
|
-
export const isEndPointTestGetParams = (props: any) is EndPointTestGetParams => 'name' in prop || 'id' in prop; // WRONG!
|
|
32
|
-
|
|
33
|
-
// .... Better
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
import Ajv from 'ajv';
|
|
37
|
-
|
|
38
|
-
const ajv = new Ajv();
|
|
39
|
-
const endPointTestGetParams = {
|
|
40
|
-
oneOf: [
|
|
41
|
-
{
|
|
42
|
-
type: 'object',
|
|
43
|
-
properties: {
|
|
44
|
-
name: {
|
|
45
|
-
type: 'string',
|
|
46
|
-
},
|
|
47
|
-
},
|
|
48
|
-
required: ['name'],
|
|
49
|
-
additionalProperties: false,
|
|
50
|
-
},
|
|
51
|
-
{
|
|
52
|
-
type: 'object',
|
|
53
|
-
properties: {
|
|
54
|
-
id: {
|
|
55
|
-
type: 'string',
|
|
56
|
-
},
|
|
57
|
-
},
|
|
58
|
-
required: ['id'],
|
|
59
|
-
additionalProperties: false,
|
|
60
|
-
},
|
|
61
|
-
],
|
|
62
|
-
};
|
|
63
|
-
|
|
64
|
-
export const isEndPointTestGetParams = ajv.compile<EndPointTestGetParams>(endPointTestGetParams);
|
|
3
|
+
> TypeScript definitions and JSON Schema validators for the Rocket.Chat REST API.
|
|
4
|
+
|
|
5
|
+
[](https://www.npmjs.com/package/@rocket.chat/rest-typings) [](https://www.npmjs.com/package/@rocket.chat/rest-typings)
|
|
6
|
+
|
|
7
|
+
This package describes Rocket.Chat's REST endpoints as types: for each path and HTTP method, the parameters it accepts and the result it returns. The entity types it refers to (`IUser`, `IRoom`, `IMessage`, ...) come from [`@rocket.chat/core-typings`](https://www.npmjs.com/package/@rocket.chat/core-typings).
|
|
8
|
+
|
|
9
|
+
It is mostly consumed indirectly. [`@rocket.chat/api-client`](https://www.npmjs.com/package/@rocket.chat/api-client) and [`@rocket.chat/ddp-client`](https://www.npmjs.com/package/@rocket.chat/ddp-client) use it to type their REST calls, and the Rocket.Chat server uses its validators to check incoming requests.
|
|
10
|
+
|
|
11
|
+
It also ships runtime code: [AJV](https://ajv.js.org/) validators for many endpoints' parameters (`isChatSendMessageProps`, `isLoginProps`, ...), the shared `ajv` and `ajvQuery` instances, and validators for standard error responses.
|
|
12
|
+
|
|
13
|
+
## Installation
|
|
14
|
+
|
|
15
|
+
```sh
|
|
16
|
+
npm install @rocket.chat/rest-typings
|
|
65
17
|
```
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
18
|
+
|
|
19
|
+
The package is published as CommonJS with TypeScript declarations.
|
|
20
|
+
|
|
21
|
+
Not every endpoint is in this package. Endpoints the server defines with its newer route API declare their types inside the Rocket.Chat server code, by augmenting `Endpoints`, and are not published here.
|
|
22
|
+
|
|
23
|
+
## Usage
|
|
24
|
+
|
|
25
|
+
### Typing a REST call
|
|
26
|
+
|
|
27
|
+
With [`@rocket.chat/api-client`](https://www.npmjs.com/package/@rocket.chat/api-client), the endpoint path picks the parameter and result types:
|
|
28
|
+
|
|
29
|
+
```ts
|
|
30
|
+
import { RestClient } from '@rocket.chat/api-client';
|
|
31
|
+
|
|
32
|
+
const client = new RestClient({ baseUrl: 'https://open.rocket.chat' });
|
|
33
|
+
|
|
34
|
+
// params: ChatSendMessage; result: { message: IMessage } (serialized)
|
|
35
|
+
const { message } = await client.post('/v1/chat.sendMessage', {
|
|
36
|
+
message: { rid: 'GENERAL', msg: 'Hello' },
|
|
37
|
+
});
|
|
80
38
|
```
|
|
81
39
|
|
|
82
|
-
|
|
40
|
+
### Typing your own client
|
|
41
|
+
|
|
42
|
+
The helper types work with any HTTP library:
|
|
43
|
+
|
|
44
|
+
```ts
|
|
45
|
+
import type { OperationParams, OperationResult, PathPattern } from '@rocket.chat/rest-typings';
|
|
46
|
+
|
|
47
|
+
async function get<TPathPattern extends PathPattern>(
|
|
48
|
+
path: TPathPattern,
|
|
49
|
+
params: OperationParams<'GET', TPathPattern>,
|
|
50
|
+
): Promise<OperationResult<'GET', TPathPattern>> {
|
|
51
|
+
const query = new URLSearchParams(params as Record<string, string>);
|
|
52
|
+
const response = await fetch(`https://open.rocket.chat/api${path}?${query}`);
|
|
53
|
+
return response.json();
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
const { user } = await get('/v1/users.info', { username: 'alice' });
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
Results are typed as the server's objects, with `Date` fields. Over JSON those arrive as strings; wrap a result in `Serialized<...>` from `@rocket.chat/core-typings` to type what you actually receive, as `@rocket.chat/api-client` does.
|
|
60
|
+
|
|
61
|
+
### Validating parameters
|
|
62
|
+
|
|
63
|
+
Many endpoints come with a compiled AJV validator named `is<Endpoint>Props`. Each one is a type guard and keeps the errors of the last call in `errors`:
|
|
64
|
+
|
|
65
|
+
```ts
|
|
66
|
+
import { isChatSendMessageProps } from '@rocket.chat/rest-typings';
|
|
67
|
+
|
|
68
|
+
if (!isChatSendMessageProps(body)) {
|
|
69
|
+
throw new Error(JSON.stringify(isChatSendMessageProps.errors));
|
|
70
|
+
}
|
|
71
|
+
|
|
72
|
+
// body is now typed as the endpoint's parameters
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
### Adding endpoint types
|
|
76
|
+
|
|
77
|
+
`Endpoints` is an interface, so you can add endpoints through declaration merging, for example for an app's custom endpoints or a route your server version has but this package does not:
|
|
78
|
+
|
|
79
|
+
```ts
|
|
80
|
+
import type { PaginatedRequest, PaginatedResult } from '@rocket.chat/rest-typings';
|
|
81
|
+
|
|
82
|
+
declare module '@rocket.chat/rest-typings' {
|
|
83
|
+
interface Endpoints {
|
|
84
|
+
'/v1/custom.endpoint': {
|
|
85
|
+
GET: (params: PaginatedRequest<{ query: string }>) => PaginatedResult<{ items: string[] }>;
|
|
86
|
+
};
|
|
87
|
+
}
|
|
88
|
+
}
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
The new path is then accepted by every client typed with this package.
|
|
83
92
|
|
|
84
|
-
|
|
93
|
+
### Experimental endpoints
|
|
94
|
+
|
|
95
|
+
Endpoints under `/api/experimental/` are typed by `ExperimentalEndpoints`. They carry no semver promise and may change or disappear in any release.
|
|
96
|
+
|
|
97
|
+
They are not part of `Endpoints`, and importing `ExperimentalEndpoints` does not add them to it. Clients typed against `Endpoints`, such as `@rocket.chat/api-client` and `@rocket.chat/ddp-client`, keep rejecting these paths. To call one with types, type the call against `ExperimentalEndpoints` yourself:
|
|
98
|
+
|
|
99
|
+
```ts
|
|
100
|
+
import type { ExperimentalEndpoints } from '@rocket.chat/rest-typings';
|
|
101
|
+
|
|
102
|
+
type SetCategory = ExperimentalEndpoints['/experimental/rooms.setCategory']['POST'];
|
|
103
|
+
|
|
104
|
+
const setCategory = async (params: Parameters<SetCategory>[0]): Promise<ReturnType<SetCategory>> => {
|
|
105
|
+
const response = await fetch(`${serverUrl}/api/experimental/rooms.setCategory`, {
|
|
106
|
+
method: 'POST',
|
|
107
|
+
headers: { 'Content-Type': 'application/json', 'X-User-Id': userId, 'X-Auth-Token': authToken },
|
|
108
|
+
body: JSON.stringify(params),
|
|
109
|
+
});
|
|
110
|
+
return response.json();
|
|
111
|
+
};
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
## API
|
|
115
|
+
|
|
116
|
+
### Endpoint map
|
|
117
|
+
|
|
118
|
+
| Export | Description |
|
|
119
|
+
| ---------------------------------------- | ------------------------------------------------------------------------------------ |
|
|
120
|
+
| `Endpoints` | Interface mapping each path pattern (`'/v1/users.info'`) to its methods' signatures. |
|
|
121
|
+
| `PathPattern` | Every path pattern, with placeholders such as `/v1/rooms.media/:rid`. |
|
|
122
|
+
| `Path` | Every concrete path, with placeholders replaced by `${string}`. |
|
|
123
|
+
| `Method` | Every HTTP method used by an endpoint. |
|
|
124
|
+
| `MethodOf<TPathPattern>` | The methods a path pattern supports. |
|
|
125
|
+
| `PathFor<TMethod>` | Paths that support a method. |
|
|
126
|
+
| `PathWithParamsFor<TMethod>` | Paths whose operation takes parameters. |
|
|
127
|
+
| `PathWithoutParamsFor<TMethod>` | Paths whose operation takes no parameters, or optional ones. |
|
|
128
|
+
| `MatchPathPattern<TPath>` | The path pattern a concrete path matches. |
|
|
129
|
+
| `OperationParams<TMethod, TPathPattern>` | Parameters of an operation. |
|
|
130
|
+
| `OperationResult<TMethod, TPathPattern>` | Result of an operation. |
|
|
131
|
+
| `ParamsFor`, `ResultFor` | Same as above, indexed through a per-method map. |
|
|
132
|
+
| `UrlParams<T>` | The `:placeholder` names in a path pattern, as an object type. |
|
|
133
|
+
| `JoinPathPattern<TBase, TSub>` | The path pattern made of a base path and a sub path. |
|
|
134
|
+
| `ExperimentalEndpoints` | Opt-in typings for `/experimental/...` endpoints. |
|
|
135
|
+
|
|
136
|
+
Endpoint groups (`ChatEndpoints`, `UsersEndpoints`, `OmnichannelEndpoints`, ...) and the parameter types for each endpoint are exported too.
|
|
137
|
+
|
|
138
|
+
### Helpers
|
|
139
|
+
|
|
140
|
+
- `PaginatedRequest<T, S>`: adds `count`, `offset` and `sort` to a parameter type.
|
|
141
|
+
- `PaginatedResult<T>`: adds `count`, `offset` and `total` to a result type.
|
|
142
|
+
- `WithItemCount`, `ReplacePlaceholders`, `IGetRoomRoles`.
|
|
143
|
+
|
|
144
|
+
### Validators
|
|
145
|
+
|
|
146
|
+
- `ajv`: the AJV instance (JSON Schema 2020-12, with `ajv-formats`) used for request bodies.
|
|
147
|
+
- `ajvQuery`: the AJV instance used for query strings. It also coerces scalars into arrays (`"c"` becomes `["c"]`).
|
|
148
|
+
- `is<Name>Props`, `is<Name>Params`, ...: compiled validators for endpoint parameters.
|
|
149
|
+
- `validateBadRequestErrorResponse`, `validateUnauthorizedErrorResponse`, `validateForbiddenErrorResponse`, `validateNotFoundErrorResponse`, `validateInternalErrorResponse`: validators for the standard error responses.
|
|
150
|
+
|
|
151
|
+
Both instances know the `basic_email` and `rfc_email` formats and the `isNotEmpty` keyword.
|
|
152
|
+
|
|
153
|
+
## Development
|
|
154
|
+
|
|
155
|
+
This package lives in the [Rocket.Chat monorepo](https://github.com/RocketChat/Rocket.Chat/tree/develop/packages/rest-typings). From the repository root:
|
|
156
|
+
|
|
157
|
+
```sh
|
|
158
|
+
yarn workspace @rocket.chat/rest-typings build
|
|
159
|
+
yarn workspace @rocket.chat/rest-typings dev
|
|
160
|
+
yarn workspace @rocket.chat/rest-typings lint
|
|
161
|
+
yarn workspace @rocket.chat/rest-typings typecheck
|
|
162
|
+
```
|
|
163
|
+
|
|
164
|
+
New server endpoints should use the validated route API, which declares their types next to the route. See [docs/api-endpoint-migration.md](https://github.com/RocketChat/Rocket.Chat/blob/develop/docs/api-endpoint-migration.md). For the choice between `ajv` and `ajvQuery`, see [docs/ajv-instances.md](https://github.com/RocketChat/Rocket.Chat/blob/develop/docs/ajv-instances.md).
|
|
165
|
+
|
|
166
|
+
### Writing typings
|
|
167
|
+
|
|
168
|
+
- Check that the definition matches the implementation. A wrong definition is worse than none.
|
|
169
|
+
- Use the generic `PaginatedRequest` and `PaginatedResult` types for paging.
|
|
170
|
+
- Write a validator for the parameters; the server uses it to reject bad requests.
|
|
171
|
+
- Test that the validator accepts and rejects what it should.
|
|
172
|
+
- Avoid incomplete and `unknown` typings.
|
|
173
|
+
|
|
174
|
+
### Require one of several parameters
|
|
175
|
+
|
|
176
|
+
If an endpoint takes a name or an id, and one of them is required, neither is optional. Express that as a union:
|
|
177
|
+
|
|
178
|
+
```ts
|
|
179
|
+
type EndpointTestGetParams = { name?: string; id?: string }; // Wrong
|
|
180
|
+
|
|
181
|
+
type EndpointTestGetParams = { name: string } | { id: string }; // Better
|
|
182
|
+
```
|
|
183
|
+
|
|
184
|
+
### Validate with a schema, not a hand-written guard
|
|
185
|
+
|
|
186
|
+
```ts
|
|
187
|
+
// Wrong
|
|
188
|
+
export const isEndpointTestGetParams = (props: any): props is EndpointTestGetParams => 'name' in props || 'id' in props;
|
|
189
|
+
|
|
190
|
+
// Better
|
|
191
|
+
import { ajvQuery } from './Ajv';
|
|
192
|
+
|
|
193
|
+
const endpointTestGetParamsSchema = {
|
|
194
|
+
oneOf: [
|
|
195
|
+
{
|
|
196
|
+
type: 'object',
|
|
197
|
+
properties: { name: { type: 'string' } },
|
|
198
|
+
required: ['name'],
|
|
199
|
+
additionalProperties: false,
|
|
200
|
+
},
|
|
201
|
+
{
|
|
202
|
+
type: 'object',
|
|
203
|
+
properties: { id: { type: 'string' } },
|
|
204
|
+
required: ['id'],
|
|
205
|
+
additionalProperties: false,
|
|
206
|
+
},
|
|
207
|
+
],
|
|
208
|
+
};
|
|
209
|
+
|
|
210
|
+
export const isEndpointTestGetParams = ajvQuery.compile<EndpointTestGetParams>(endpointTestGetParamsSchema);
|
|
211
|
+
```
|
|
212
|
+
|
|
213
|
+
Compile with the shared instances, not a new `Ajv()`: `ajvQuery` for query-string parameters, `ajv` for request bodies.
|
|
214
|
+
|
|
215
|
+
## License
|
|
85
216
|
|
|
217
|
+
MIT — see [LICENSE](https://github.com/RocketChat/Rocket.Chat/blob/develop/LICENSE).
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { AppLogsProps } from './appLogsProps';
|
|
2
|
-
export type AppLogsExportProps = Omit<AppLogsProps, 'appId' | 'offset'
|
|
2
|
+
export type AppLogsExportProps = Omit<AppLogsProps, 'appId' | 'offset'> & {
|
|
3
3
|
type: 'json' | 'csv';
|
|
4
4
|
};
|
|
5
5
|
export declare const isAppLogsExportProps: import("ajv").ValidateFunction<AppLogsExportProps>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"appLogsExportProps.d.ts","sourceRoot":"","sources":["../../src/apps/appLogsExportProps.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAGnD,MAAM,MAAM,kBAAkB,GAAG,IAAI,CAAC,YAAY,EAAE,OAAO,GAAG,QAAQ,
|
|
1
|
+
{"version":3,"file":"appLogsExportProps.d.ts","sourceRoot":"","sources":["../../src/apps/appLogsExportProps.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAGnD,MAAM,MAAM,kBAAkB,GAAG,IAAI,CAAC,YAAY,EAAE,OAAO,GAAG,QAAQ,CAAC,GAAG;IACzE,IAAI,EAAE,MAAM,GAAG,KAAK,CAAC;CACrB,CAAC;AAkBF,eAAO,MAAM,oBAAoB,oDAAiE,CAAC"}
|
package/dist/default/index.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/default/index.ts"],"names":[],"mappings":"AAEA,KAAK,mBAAmB,GAAG;IAAE,gBAAgB,CAAC,EAAE,OAAO,CAAA;CAAE,CAAC;AAc1D,eAAO,MAAM,qBAAqB,qDAAmE,CAAC;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/default/index.ts"],"names":[],"mappings":"AAEA,KAAK,mBAAmB,GAAG;IAAE,gBAAgB,CAAC,EAAE,OAAO,CAAA;CAAE,CAAC;AAc1D,eAAO,MAAM,qBAAqB,qDAAmE,CAAC;AAEtG,MAAM,WAAW,gBAAgB;IAChC,OAAO,EAAE;QACR,GAAG,EAAE,MACF;YACA,IAAI,EAAE;gBACL,KAAK,EAAE;oBACN,IAAI,EAAE,MAAM,CAAC;oBACb,IAAI,EAAE,MAAM,CAAC;oBACb,IAAI,EAAE,MAAM,CAAC;oBACb,UAAU,EAAE,MAAM,CAAC;oBACnB,WAAW,EAAE,MAAM,CAAC;oBACpB,SAAS,EAAE,MAAM,CAAC;oBAClB,QAAQ,EAAE,MAAM,CAAC;oBACjB,WAAW,EAAE,MAAM,CAAC;iBACpB,CAAC;gBACF,MAAM,EAAE;oBACP,MAAM,CAAC,EAAE,MAAM,CAAC;oBAChB,MAAM,CAAC,EAAE,MAAM,CAAC;oBAChB,IAAI,CAAC,EAAE,MAAM,CAAC;oBACd,IAAI,CAAC,EAAE,MAAM,CAAC;oBACd,OAAO,CAAC,EAAE,MAAM,CAAC;oBACjB,GAAG,CAAC,EAAE,MAAM,CAAC;iBACb,CAAC;gBACF,qBAAqB,EAAE,MAAM,CAAC;gBAC9B,OAAO,EAAE,MAAM,CAAC;gBAChB,GAAG,CAAC,EAAE,MAAM,CAAC;gBACb,MAAM,CAAC,EAAE,MAAM,CAAC;aAChB,CAAC;SACD,GACD;YACA,OAAO,EAAE,MAAM,GAAG,SAAS,CAAC;SAC3B,CAAC;KACL,CAAC;IACF,YAAY,EAAE;QACb,GAAG,EAAE,CAAC,MAAM,EAAE,mBAAmB,KAAK;YACrC,OAAO,EAAE,MAAM,CAAC;YAChB,IAAI,EAAE;gBACL,KAAK,EAAE,MAAM,CAAC;gBACd,WAAW,EAAE,MAAM,CAAC;gBACpB,OAAO,EAAE,MAAM,CAAC;aAChB,CAAC;YACF,OAAO,EAAE;gBACR,GAAG,EAAE,MAAM,CAAC;aACZ,EAAE,CAAC;YACJ,UAAU,EAAE;gBACX,eAAe,EAAE;oBAChB,MAAM,EAAE;wBACP,IAAI,EAAE,MAAM,CAAC;wBACb,EAAE,EAAE,MAAM,CAAC;wBACX,IAAI,EAAE,MAAM,CAAC;qBACb,CAAC;oBACF,SAAS,EAAE;wBACV,IAAI,EAAE,MAAM,CAAC;wBACb,EAAE,EAAE,MAAM,CAAC;wBACX,IAAI,EAAE,MAAM,CAAC;qBACb,CAAC;iBACF,CAAC;gBACF,OAAO,EAAE,OAAO,CAAC;aACjB,CAAC;YACF,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;YAC/C,wFAAwF;YACxF,OAAO,CAAC,EAAE,KAAK,CAAC;SAChB,CAAC;KACF,CAAC;CACF"}
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Opt-in typings for experimental REST endpoints (`/api/experimental/...`).
|
|
3
|
+
*
|
|
4
|
+
* These are intentionally **not** merged into the `Endpoints` union exported
|
|
5
|
+
* from the package root, so the stable typed client surface (`PathPattern`,
|
|
6
|
+
* `Method`, `Path`, the SDK) stays free of unstable paths. Consumers who want
|
|
7
|
+
* typed experimental calls import `ExperimentalEndpoints` explicitly.
|
|
8
|
+
*
|
|
9
|
+
* Endpoints under this namespace carry **no semver promise**: they may change
|
|
10
|
+
* shape or be removed in any release without a deprecation cycle. See
|
|
11
|
+
* `docs/experimental-api-endpoints.md`.
|
|
12
|
+
*
|
|
13
|
+
* Declare new experimental endpoints here, following the per-resource style of
|
|
14
|
+
* the `/v1` endpoint types (e.g. `v1/calendar`). Every path key must begin with
|
|
15
|
+
* `/experimental/`. For example:
|
|
16
|
+
*
|
|
17
|
+
* ```ts
|
|
18
|
+
* export type ExperimentalEndpoints = {
|
|
19
|
+
* '/experimental/example.info': {
|
|
20
|
+
* GET: (params: { id: string }) => { id: string; value: number };
|
|
21
|
+
* };
|
|
22
|
+
* };
|
|
23
|
+
* ```
|
|
24
|
+
*/
|
|
25
|
+
export type ExperimentalEndpoints = {
|
|
26
|
+
'/experimental/rooms.setCategory': {
|
|
27
|
+
POST: (params: {
|
|
28
|
+
roomIds: string[];
|
|
29
|
+
category: string | null;
|
|
30
|
+
}) => {
|
|
31
|
+
success: true;
|
|
32
|
+
};
|
|
33
|
+
};
|
|
34
|
+
};
|
|
35
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/experimental/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,MAAM,qBAAqB,GAAG;IACnC,iCAAiC,EAAE;QAClC,IAAI,EAAE,CAAC,MAAM,EAAE;YAAE,OAAO,EAAE,MAAM,EAAE,CAAC;YAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;SAAE,KAAK;YAAE,OAAO,EAAE,IAAI,CAAA;SAAE,CAAC;KACpF,CAAC;CACF,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/experimental/index.ts"],"names":[],"mappings":""}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"PaginatedRequest.d.ts","sourceRoot":"","sources":["../../src/helpers/PaginatedRequest.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,gBAAgB,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC,SAAS,MAAM,GAAG,MAAM,IAAI;IACjH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,GAAG,MAAM,CAAC;
|
|
1
|
+
{"version":3,"file":"PaginatedRequest.d.ts","sourceRoot":"","sources":["../../src/helpers/PaginatedRequest.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,gBAAgB,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC,SAAS,MAAM,GAAG,MAAM,IAAI;IACjH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,GAAG,MAAM,CAAC;CACxC,GAAG,CAAC,CAAC"}
|
package/dist/index.d.ts
CHANGED
|
@@ -38,13 +38,14 @@ import type { RolesEndpoints } from './v1/roles';
|
|
|
38
38
|
import type { RoomsEndpoints } from './v1/rooms';
|
|
39
39
|
import type { ServerEventsEndpoints } from './v1/server-events';
|
|
40
40
|
import type { SettingsEndpoints } from './v1/settings';
|
|
41
|
+
import type { SetupWizardEndpoints } from './v1/setupWizard';
|
|
41
42
|
import type { StatisticsEndpoints } from './v1/statistics';
|
|
42
43
|
import type { SubscriptionsEndpoints } from './v1/subscriptionsEndpoints';
|
|
43
44
|
import type { TeamsEndpoints } from './v1/teams';
|
|
44
45
|
import type { TwoFactorChallengesEndpoints } from './v1/twoFactorChallenges';
|
|
45
46
|
import type { UsersEndpoints } from './v1/users';
|
|
46
47
|
import type { VideoConferenceEndpoints } from './v1/videoConference';
|
|
47
|
-
export interface Endpoints extends AISearchEndpoints, ChannelsEndpoints, MeEndpoints, ModerationEndpoints, BannersEndpoints, ChatEndpoints, CommandsEndpoints, CloudEndpoints, CommandsEndpoints, CustomUserStatusEndpoints, DmEndpoints, DirectoryEndpoint, EmojiCustomEndpoints, GroupsEndpoints, ImEndpoints, LDAPEndpoints, RoomsEndpoints, PushEndpoints, RolesEndpoints, TeamsEndpoints, SettingsEndpoints, UsersEndpoints, AppsEndpoints, OmnichannelEndpoints, StatisticsEndpoints, LicensesEndpoints, MiscEndpoints, PresenceEndpoints, InstancesEndpoints, IntegrationsEndpoints, IntegrationHooksEndpoints, VideoConferenceEndpoints, InvitesEndpoints, E2eEndpoints, AssetsEndpoints, EmailInboxEndpoints, MailerEndpoints, SubscriptionsEndpoints, AutoTranslateEndpoints, ImportEndpoints, FederationEndpoints, CalendarEndpoints, AuthEndpoints, ImportEndpoints, ServerEventsEndpoints, TwoFactorChallengesEndpoints, DefaultEndpoints {
|
|
48
|
+
export interface Endpoints extends AISearchEndpoints, ChannelsEndpoints, MeEndpoints, ModerationEndpoints, BannersEndpoints, ChatEndpoints, CommandsEndpoints, CloudEndpoints, CommandsEndpoints, CustomUserStatusEndpoints, DmEndpoints, DirectoryEndpoint, EmojiCustomEndpoints, GroupsEndpoints, ImEndpoints, LDAPEndpoints, RoomsEndpoints, PushEndpoints, RolesEndpoints, TeamsEndpoints, SettingsEndpoints, SetupWizardEndpoints, UsersEndpoints, AppsEndpoints, OmnichannelEndpoints, StatisticsEndpoints, LicensesEndpoints, MiscEndpoints, PresenceEndpoints, InstancesEndpoints, IntegrationsEndpoints, IntegrationHooksEndpoints, VideoConferenceEndpoints, InvitesEndpoints, E2eEndpoints, AssetsEndpoints, EmailInboxEndpoints, MailerEndpoints, SubscriptionsEndpoints, AutoTranslateEndpoints, ImportEndpoints, FederationEndpoints, CalendarEndpoints, AuthEndpoints, ImportEndpoints, ServerEventsEndpoints, TwoFactorChallengesEndpoints, DefaultEndpoints {
|
|
48
49
|
}
|
|
49
50
|
type OperationsByPathPatternAndMethod<TEndpoints extends Endpoints, TPathPattern extends keyof TEndpoints, TMethod extends KeyOfEach<TEndpoints[TPathPattern]> = KeyOfEach<TEndpoints[TPathPattern]>> = TMethod extends any ? {
|
|
50
51
|
pathPattern: TPathPattern;
|
|
@@ -109,6 +110,7 @@ export * from './v1/teams';
|
|
|
109
110
|
export * from './v1/videoConference';
|
|
110
111
|
export * from './v1/assets';
|
|
111
112
|
export * from './v1/aiSearch';
|
|
113
|
+
export { abacCreationAttributesSchema } from './v1/abacCreationAttributes';
|
|
112
114
|
export * from './v1/channels';
|
|
113
115
|
export * from './v1/customSounds';
|
|
114
116
|
export type * from './v1/customUserStatus';
|
|
@@ -133,6 +135,7 @@ export type * from './helpers/WithItemCount';
|
|
|
133
135
|
export * from './v1/emojiCustom';
|
|
134
136
|
export type * from './v1/instances';
|
|
135
137
|
export * from './v1/ldap';
|
|
138
|
+
export * from './v1/saml';
|
|
136
139
|
export * from './v1/users';
|
|
137
140
|
export * from './v1/users/UsersSetAvatarParamsPOST';
|
|
138
141
|
export * from './v1/users/UsersSetPreferenceParamsPOST';
|
|
@@ -155,7 +158,7 @@ export * from './v1/e2e';
|
|
|
155
158
|
export * from './v1/import';
|
|
156
159
|
export * from './v1/email-inbox';
|
|
157
160
|
export * from './v1/calendar';
|
|
158
|
-
export * from './v1/federation';
|
|
161
|
+
export type * from './v1/federation';
|
|
159
162
|
export * from './v1/rooms';
|
|
160
163
|
export * from './v1/groups';
|
|
161
164
|
export * from './v1/chat';
|
|
@@ -164,5 +167,7 @@ export * from './v1/cloud';
|
|
|
164
167
|
export * from './v1/banners';
|
|
165
168
|
export * from './default';
|
|
166
169
|
export * from './v1/twoFactorChallenges';
|
|
170
|
+
export type * from './experimental';
|
|
167
171
|
export * from './v1/Ajv';
|
|
172
|
+
export * from './v1/pagination';
|
|
168
173
|
//# sourceMappingURL=index.d.ts.map
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AAE3D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,QAAQ,CAAC;AAC5C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAClD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAC;AACzE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AACvD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AACnD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAC/C,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,oBAAoB,CAAC;AACjE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AACrD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AACvD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AACvD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAC/C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AACjD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AACvD,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,uBAAuB,CAAC;AACvE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AACxD,OAAO,KAAK,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AACxD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAC7C,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AAC5D,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AAC7D,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AAC3D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AACnD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AACnD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AACzD,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,mBAAmB,CAAC;AAC/D,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,yBAAyB,CAAC;AACzE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AACrD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAC/C,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AACvD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AACnD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAC3C,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAC/C,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AAC3D,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AAC7D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AACvD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAC/C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AACjD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AACjD,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAChE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AACvD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AAC3D,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AAC1E,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AACjD,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,0BAA0B,CAAC;AAC7E,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AACjD,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,sBAAsB,CAAC;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AAE3D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,QAAQ,CAAC;AAC5C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAClD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAC;AACzE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AACvD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AACnD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAC/C,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,oBAAoB,CAAC;AACjE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AACrD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AACvD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AACvD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAC/C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AACjD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AACvD,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,uBAAuB,CAAC;AACvE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AACxD,OAAO,KAAK,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AACxD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAC7C,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AAC5D,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AAC7D,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AAC3D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AACnD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AACnD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AACzD,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,mBAAmB,CAAC;AAC/D,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,yBAAyB,CAAC;AACzE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AACrD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAC/C,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AACvD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AACnD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAC3C,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAC/C,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AAC3D,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AAC7D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AACvD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAC/C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AACjD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AACjD,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAChE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AACvD,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AAC7D,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AAC3D,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AAC1E,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AACjD,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,0BAA0B,CAAC;AAC7E,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AACjD,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,sBAAsB,CAAC;AAErE,MAAM,WAAW,SAChB,SACC,iBAAiB,EACjB,iBAAiB,EACjB,WAAW,EACX,mBAAmB,EACnB,gBAAgB,EAChB,aAAa,EACb,iBAAiB,EACjB,cAAc,EACd,iBAAiB,EACjB,yBAAyB,EACzB,WAAW,EACX,iBAAiB,EACjB,oBAAoB,EACpB,eAAe,EACf,WAAW,EACX,aAAa,EACb,cAAc,EACd,aAAa,EACb,cAAc,EACd,cAAc,EACd,iBAAiB,EACjB,oBAAoB,EACpB,cAAc,EACd,aAAa,EACb,oBAAoB,EACpB,mBAAmB,EACnB,iBAAiB,EACjB,aAAa,EACb,iBAAiB,EACjB,kBAAkB,EAClB,qBAAqB,EACrB,yBAAyB,EACzB,wBAAwB,EACxB,gBAAgB,EAChB,YAAY,EACZ,eAAe,EACf,mBAAmB,EACnB,eAAe,EACf,sBAAsB,EACtB,sBAAsB,EACtB,eAAe,EACf,mBAAmB,EACnB,iBAAiB,EACjB,aAAa,EACb,eAAe,EACf,qBAAqB,EACrB,4BAA4B,EAC5B,gBAAgB;CAAG;AAErB,KAAK,gCAAgC,CACpC,UAAU,SAAS,SAAS,EAC5B,YAAY,SAAS,MAAM,UAAU,EACrC,OAAO,SAAS,SAAS,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC,GAAG,SAAS,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC,IACtF,OAAO,SAAS,GAAG,GACpB;IACA,WAAW,EAAE,YAAY,CAAC;IAC1B,MAAM,EAAE,OAAO,CAAC;IAChB,EAAE,EAAE,UAAU,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,CAAC;IACtC,IAAI,EAAE,mBAAmB,CAAC,YAAY,SAAS,MAAM,GAAG,YAAY,GAAG,KAAK,CAAC,CAAC;IAC9E,MAAM,EAAE,SAAS,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;IACrD,MAAM,EAAE,SAAS,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;CACrD,GACA,KAAK,CAAC;AAET,KAAK,uBAAuB,CAAC,UAAU,SAAS,SAAS,EAAE,YAAY,SAAS,MAAM,UAAU,IAAI,YAAY,SAAS,GAAG,GACzH,gCAAgC,CAAC,UAAU,EAAE,YAAY,CAAC,GAC1D,KAAK,CAAC;AAET,KAAK,UAAU,GAAG,uBAAuB,CAAC,SAAS,EAAE,MAAM,SAAS,CAAC,CAAC;AAEtE,MAAM,MAAM,WAAW,GAAG,UAAU,CAAC,aAAa,CAAC,CAAC;AAEpD,MAAM,MAAM,MAAM,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC;AAE1C,MAAM,MAAM,IAAI,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC;AAEtC,KAAK,eAAe,GAAG;KACrB,UAAU,IAAI,UAAU,IAAI,UAAU,CAAC,QAAQ,CAAC,GAAG,UAAU,CAAC,MAAM,CAAC;CACtE,CAAC;AAEF,KAAK,yBAAyB,GAAG;KAC/B,UAAU,IAAI,UAAU,IAAI,UAAU,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,SAAS;QAAE,MAAM,EAAE,CAAC,CAAA;KAAE,GAAG,KAAK,GAAG,UAAU,CAAC,QAAQ,CAAC,GAAG,UAAU,CAAC,MAAM,CAAC;CACnI,CAAC;AAEF,KAAK,4BAA4B,GAAG;KAElC,UAAU,IAAI,UAAU,IAAI,UAAU,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,SAAS;QAAE,MAAM,EAAE,CAAC,CAAA;KAAE,GAC3E,UAAU,CAAC,QAAQ,CAAC,GACpB,SAAS,SAAS,UAAU,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,GAChD,UAAU,CAAC,QAAQ,CAAC,GACpB,KAAK,GACP,UAAU,CAAC,MAAM,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,OAAO,CAAC,OAAO,SAAS,MAAM,IAAI,eAAe,CAAC,OAAO,CAAC,CAAC;AAEvE,MAAM,MAAM,iBAAiB,CAAC,OAAO,SAAS,MAAM,IAAI,yBAAyB,CAAC,OAAO,SAAS,MAAM,yBAAyB,GAC9H,OAAO,GACP,KAAK,CAAC,CAAC;AAEV,MAAM,MAAM,oBAAoB,CAAC,OAAO,SAAS,MAAM,IAAI,4BAA4B,CAAC,OAAO,SAAS,MAAM,4BAA4B,GACvI,OAAO,GACP,KAAK,CAAC,CAAC;AAEV,KAAK,8BAA8B,GAAG;KACpC,OAAO,IAAI,MAAM,GAAG;SACnB,YAAY,IAAI,MAAM,SAAS,GAAG,OAAO,SAAS,MAAM,SAAS,CAAC,YAAY,CAAC,GAC7E,SAAS,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,SAAS,MAAM,UAAU,GACxD,UAAU,SAAS,CAAC,GAAG,IAAI,EAAE,GAAG,KAAK,GAAG,GACvC,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,GACzB,KAAK,GACN,KAAK,GACN,KAAK;KACR;CACD,CAAC;AAEF,KAAK,8BAA8B,GAAG;KACpC,OAAO,IAAI,MAAM,GAAG;SACnB,YAAY,IAAI,MAAM,SAAS,GAAG,OAAO,SAAS,MAAM,SAAS,CAAC,YAAY,CAAC,GAC7E,SAAS,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,SAAS,MAAM,UAAU,GACxD,UAAU,SAAS,CAAC,GAAG,IAAI,EAAE,GAAG,KAAK,GAAG,GACvC,UAAU,CAAC,UAAU,CAAC,GACtB,KAAK,GACN,KAAK,GACN,KAAK;KACR;CACD,CAAC;AAEF,MAAM,MAAM,SAAS,CAAC,OAAO,SAAS,MAAM,EAAE,YAAY,SAAS,WAAW,IAAI,8BAA8B,CAAC,OAAO,CAAC,CAAC,YAAY,CAAC,CAAC;AAExI,MAAM,MAAM,SAAS,CAAC,OAAO,SAAS,MAAM,EAAE,YAAY,SAAS,WAAW,IAAI,8BAA8B,CAAC,OAAO,CAAC,CAAC,YAAY,CAAC,CAAC;AAExI,MAAM,MAAM,gBAAgB,CAAC,KAAK,SAAS,IAAI,IAAI,KAAK,SAAS,GAAG,GAAG,OAAO,CAAC,UAAU,EAAE;IAAE,IAAI,EAAE,KAAK,CAAA;CAAE,CAAC,CAAC,aAAa,CAAC,GAAG,KAAK,CAAC;AAEnI,MAAM,MAAM,eAAe,CAAC,SAAS,SAAS,MAAM,EAAE,eAAe,SAAS,MAAM,IAAI,OAAO,CAC9F,WAAW,EACX,GAAG,SAAS,GAAG,eAAe,SAAS,EAAE,GAAG,eAAe,GAAG,IAAI,eAAe,EAAE,EAAE,GAAG,eAAe,CACvG,CAAC;AAEF,KAAK,SAAS,CAAC,UAAU,IAAI,UAAU,SAAS,CAAC,GAAG,IAAI,EAAE,GAAG,KAAK,GAAG,GAAG,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC;AAE1G,KAAK,SAAS,CAAC,UAAU,IAAI,UAAU,SAAS,CAAC,GAAG,IAAI,EAAE,GAAG,KAAK,GAAG,GAAG,UAAU,CAAC,UAAU,CAAC,GAAG,KAAK,CAAC;AAEvG,MAAM,MAAM,eAAe,CAAC,OAAO,SAAS,MAAM,EAAE,YAAY,SAAS,WAAW,IAAI,OAAO,SAAS,MAAM,SAAS,CAAC,YAAY,CAAC,GAClI,SAAS,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,CAAC,GAC3C,KAAK,CAAC;AAET,MAAM,MAAM,eAAe,CAAC,OAAO,SAAS,MAAM,EAAE,YAAY,SAAS,WAAW,IAAI,OAAO,SAAS,MAAM,SAAS,CAAC,YAAY,CAAC,GAClI,SAAS,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,CAAC,GAC3C,KAAK,CAAC;AAET,MAAM,MAAM,SAAS,CAAC,CAAC,SAAS,MAAM,IAAI,MAAM,SAAS,CAAC,GACvD,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GACtB,CAAC,SAAS,GAAG,MAAM,IAAI,MAAM,KAAK,IAAI,MAAM,IAAI,EAAE,GACjD;KAAG,CAAC,IAAI,KAAK,GAAG,MAAM,SAAS,CAAC,IAAI,CAAC,GAAG,MAAM;CAAE,GAChD,CAAC,SAAS,GAAG,MAAM,IAAI,MAAM,KAAK,EAAE,GACnC;KAAG,CAAC,IAAI,KAAK,GAAG,MAAM;CAAE,GACxB,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;AAEvC,MAAM,MAAM,QAAQ,CAAC,YAAY,SAAS,WAAW,IAAI,YAAY,SAAS,GAAG,GAAG,MAAM,SAAS,CAAC,YAAY,CAAC,GAAG,KAAK,CAAC;AAE1H,cAAc,QAAQ,CAAC;AACvB,mBAAmB,eAAe,CAAC;AACnC,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAC3B,cAAc,sBAAsB,CAAC;AACrC,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC;AAC9B,OAAO,EAAE,4BAA4B,EAAE,MAAM,6BAA6B,CAAC;AAC3E,cAAc,eAAe,CAAC;AAC9B,cAAc,mBAAmB,CAAC;AAClC,mBAAmB,uBAAuB,CAAC;AAC3C,cAAc,6BAA6B,CAAC;AAC5C,mBAAmB,aAAa,CAAC;AACjC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,yCAAyC,CAAC;AACxD,cAAc,WAAW,CAAC;AAC1B,cAAc,cAAc,CAAC;AAC7B,cAAc,SAAS,CAAC;AACxB,cAAc,wBAAwB,CAAC;AACvC,cAAc,mBAAmB,CAAC;AAClC,cAAc,eAAe,CAAC;AAC9B,cAAc,kBAAkB,CAAC;AACjC,cAAc,WAAW,CAAC;AAC1B,mBAAmB,yBAAyB,CAAC;AAC7C,mBAAmB,4BAA4B,CAAC;AAChD,mBAAmB,2BAA2B,CAAC;AAC/C,mBAAmB,+BAA+B,CAAC;AACnD,mBAAmB,yBAAyB,CAAC;AAC7C,cAAc,kBAAkB,CAAC;AACjC,mBAAmB,gBAAgB,CAAC;AACpC,cAAc,WAAW,CAAC;AAC1B,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAC3B,cAAc,qCAAqC,CAAC;AACpD,cAAc,yCAAyC,CAAC;AACxD,cAAc,8CAA8C,CAAC;AAC7D,cAAc,kCAAkC,CAAC;AACjD,cAAc,oDAAoD,CAAC;AACnE,cAAc,iDAAiD,CAAC;AAChE,cAAc,oCAAoC,CAAC;AACnD,cAAc,mCAAmC,CAAC;AAClD,cAAc,8CAA8C,CAAC;AAC7D,cAAc,sCAAsC,CAAC;AACrD,cAAc,oCAAoC,CAAC;AACnD,cAAc,iBAAiB,CAAC;AAChC,cAAc,oBAAoB,CAAC;AACnC,cAAc,iBAAiB,CAAC;AAEhC,cAAc,gEAAgE,CAAC;AAC/E,cAAc,wDAAwD,CAAC;AACvE,cAAc,mDAAmD,CAAC;AAClE,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,cAAc,kBAAkB,CAAC;AACjC,cAAc,eAAe,CAAC;AAC9B,mBAAmB,iBAAiB,CAAC;AACrC,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,WAAW,CAAC;AAC1B,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAC3B,cAAc,cAAc,CAAC;AAC7B,cAAc,WAAW,CAAC;AAC1B,cAAc,0BAA0B,CAAC;AAIzC,mBAAmB,gBAAgB,CAAC;AAGpC,cAAc,UAAU,CAAC;AACzB,cAAc,iBAAiB,CAAC"}
|
package/dist/index.js
CHANGED
|
@@ -5,6 +5,7 @@ export * from './v1/teams';
|
|
|
5
5
|
export * from './v1/videoConference';
|
|
6
6
|
export * from './v1/assets';
|
|
7
7
|
export * from './v1/aiSearch';
|
|
8
|
+
export { abacCreationAttributesSchema } from './v1/abacCreationAttributes';
|
|
8
9
|
export * from './v1/channels';
|
|
9
10
|
export * from './v1/customSounds';
|
|
10
11
|
export * from './v1/subscriptionsEndpoints';
|
|
@@ -21,6 +22,7 @@ export * from './v1/omnichannel';
|
|
|
21
22
|
export * from './v1/push';
|
|
22
23
|
export * from './v1/emojiCustom';
|
|
23
24
|
export * from './v1/ldap';
|
|
25
|
+
export * from './v1/saml';
|
|
24
26
|
export * from './v1/users';
|
|
25
27
|
export * from './v1/users/UsersSetAvatarParamsPOST';
|
|
26
28
|
export * from './v1/users/UsersSetPreferenceParamsPOST';
|
|
@@ -43,7 +45,6 @@ export * from './v1/e2e';
|
|
|
43
45
|
export * from './v1/import';
|
|
44
46
|
export * from './v1/email-inbox';
|
|
45
47
|
export * from './v1/calendar';
|
|
46
|
-
export * from './v1/federation';
|
|
47
48
|
export * from './v1/rooms';
|
|
48
49
|
export * from './v1/groups';
|
|
49
50
|
export * from './v1/chat';
|
|
@@ -54,4 +55,5 @@ export * from './default';
|
|
|
54
55
|
export * from './v1/twoFactorChallenges';
|
|
55
56
|
// Export the ajv instance for use in other packages
|
|
56
57
|
export * from './v1/Ajv';
|
|
58
|
+
export * from './v1/pagination';
|
|
57
59
|
//# sourceMappingURL=index.js.map
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAoNA,cAAc,QAAQ,CAAC;AAEvB,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAC3B,cAAc,sBAAsB,CAAC;AACrC,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC;AAC9B,OAAO,EAAE,4BAA4B,EAAE,MAAM,6BAA6B,CAAC;AAC3E,cAAc,eAAe,CAAC;AAC9B,cAAc,mBAAmB,CAAC;AAElC,cAAc,6BAA6B,CAAC;AAE5C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,yCAAyC,CAAC;AACxD,cAAc,WAAW,CAAC;AAC1B,cAAc,cAAc,CAAC;AAC7B,cAAc,SAAS,CAAC;AACxB,cAAc,wBAAwB,CAAC;AACvC,cAAc,mBAAmB,CAAC;AAClC,cAAc,eAAe,CAAC;AAC9B,cAAc,kBAAkB,CAAC;AACjC,cAAc,WAAW,CAAC;AAM1B,cAAc,kBAAkB,CAAC;AAEjC,cAAc,WAAW,CAAC;AAC1B,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAC3B,cAAc,qCAAqC,CAAC;AACpD,cAAc,yCAAyC,CAAC;AACxD,cAAc,8CAA8C,CAAC;AAC7D,cAAc,kCAAkC,CAAC;AACjD,cAAc,oDAAoD,CAAC;AACnE,cAAc,iDAAiD,CAAC;AAChE,cAAc,oCAAoC,CAAC;AACnD,cAAc,mCAAmC,CAAC;AAClD,cAAc,8CAA8C,CAAC;AAC7D,cAAc,sCAAsC,CAAC;AACrD,cAAc,oCAAoC,CAAC;AACnD,cAAc,iBAAiB,CAAC;AAChC,cAAc,oBAAoB,CAAC;AACnC,cAAc,iBAAiB,CAAC;AAEhC,cAAc,gEAAgE,CAAC;AAC/E,cAAc,wDAAwD,CAAC;AACvE,cAAc,mDAAmD,CAAC;AAClE,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,cAAc,kBAAkB,CAAC;AACjC,cAAc,eAAe,CAAC;AAE9B,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,WAAW,CAAC;AAC1B,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAC3B,cAAc,cAAc,CAAC;AAC7B,cAAc,WAAW,CAAC;AAC1B,cAAc,0BAA0B,CAAC;AAMzC,oDAAoD;AACpD,cAAc,UAAU,CAAC;AACzB,cAAc,iBAAiB,CAAC"}
|
package/dist/v1/Ajv.d.ts
CHANGED
|
@@ -10,7 +10,7 @@ type BadRequestErrorResponse = {
|
|
|
10
10
|
stack?: string;
|
|
11
11
|
details?: string | object | object[];
|
|
12
12
|
};
|
|
13
|
-
export declare const validateBadRequestErrorResponse: import("ajv
|
|
13
|
+
export declare const validateBadRequestErrorResponse: import("ajv").ValidateFunction<BadRequestErrorResponse>;
|
|
14
14
|
type UnauthorizedErrorResponse = {
|
|
15
15
|
success: false;
|
|
16
16
|
status?: string;
|
|
@@ -18,7 +18,7 @@ type UnauthorizedErrorResponse = {
|
|
|
18
18
|
error?: string;
|
|
19
19
|
errorType?: string;
|
|
20
20
|
};
|
|
21
|
-
export declare const validateUnauthorizedErrorResponse: import("ajv
|
|
21
|
+
export declare const validateUnauthorizedErrorResponse: import("ajv").ValidateFunction<UnauthorizedErrorResponse>;
|
|
22
22
|
type ForbiddenErrorResponse = {
|
|
23
23
|
success: false;
|
|
24
24
|
status?: string;
|
|
@@ -26,15 +26,15 @@ type ForbiddenErrorResponse = {
|
|
|
26
26
|
error?: string;
|
|
27
27
|
errorType?: string;
|
|
28
28
|
};
|
|
29
|
-
export declare const validateForbiddenErrorResponse: import("ajv
|
|
29
|
+
export declare const validateForbiddenErrorResponse: import("ajv").ValidateFunction<ForbiddenErrorResponse>;
|
|
30
30
|
type NotFoundErrorResponse = {
|
|
31
31
|
success: false;
|
|
32
32
|
error: string;
|
|
33
33
|
};
|
|
34
|
-
export declare const validateNotFoundErrorResponse: import("ajv
|
|
34
|
+
export declare const validateNotFoundErrorResponse: import("ajv").ValidateFunction<NotFoundErrorResponse>;
|
|
35
35
|
type InternalErrorResponse = {
|
|
36
36
|
success: false;
|
|
37
37
|
error: string;
|
|
38
38
|
};
|
|
39
|
-
export declare const validateInternalErrorResponse: import("ajv
|
|
39
|
+
export declare const validateInternalErrorResponse: import("ajv").ValidateFunction<InternalErrorResponse>;
|
|
40
40
|
//# sourceMappingURL=Ajv.d.ts.map
|
package/dist/v1/Ajv.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Ajv.d.ts","sourceRoot":"","sources":["../../src/v1/Ajv.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,eAAe,CAAC;AAGhC,QAAA,MAAM,GAAG,KAKP,CAAC;AAEH,6HAA6H;AAC7H,QAAA,MAAM,QAAQ,KAKZ,CAAC;
|
|
1
|
+
{"version":3,"file":"Ajv.d.ts","sourceRoot":"","sources":["../../src/v1/Ajv.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,eAAe,CAAC;AAGhC,QAAA,MAAM,GAAG,KAKP,CAAC;AAEH,6HAA6H;AAC7H,QAAA,MAAM,QAAQ,KAKZ,CAAC;AAmEH,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,CAAC;AAEzB,KAAK,uBAAuB,GAAG;IAC9B,OAAO,EAAE,KAAK,CAAC;IACf,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,CAAC;CACrC,CAAC;AAkBF,eAAO,MAAM,+BAA+B,yDAAsE,CAAC;AAEnH,KAAK,yBAAyB,GAAG;IAChC,OAAO,EAAE,KAAK,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAgBF,eAAO,MAAM,iCAAiC,2DAA0E,CAAC;AAEzH,KAAK,sBAAsB,GAAG;IAC7B,OAAO,EAAE,KAAK,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAgBF,eAAO,MAAM,8BAA8B,wDAAoE,CAAC;AAEhH,KAAK,qBAAqB,GAAG;IAC5B,OAAO,EAAE,KAAK,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;CACd,CAAC;AAYF,eAAO,MAAM,6BAA6B,uDAAkE,CAAC;AAE7G,KAAK,qBAAqB,GAAG;IAC5B,OAAO,EAAE,KAAK,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;CACd,CAAC;AAYF,eAAO,MAAM,6BAA6B,uDAAkE,CAAC"}
|