@selfcommunity/api-services 0.1.6 → 0.1.7
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/lib/cjs/index.js +36 -0
- package/lib/cjs/services/category/index.js +168 -286
- package/lib/cjs/services/comment/index.js +107 -186
- package/lib/cjs/services/custom_adv/index.js +31 -51
- package/lib/cjs/services/custom_page/index.js +32 -52
- package/lib/cjs/services/data_portability/index.js +18 -43
- package/lib/cjs/services/embed/index.js +90 -151
- package/lib/cjs/services/feature/index.js +8 -16
- package/lib/cjs/services/feed/index.js +46 -81
- package/lib/cjs/services/feed_object/index.js +339 -505
- package/lib/cjs/services/incubator/index.js +64 -116
- package/lib/cjs/services/insight/index.js +51 -94
- package/lib/cjs/services/legal_page/index.js +60 -101
- package/lib/cjs/services/locality/index.js +14 -30
- package/lib/cjs/services/loyalty/index.js +92 -154
- package/lib/cjs/services/media/index.js +80 -122
- package/lib/cjs/services/moderation/index.js +65 -103
- package/lib/cjs/services/notification/index.js +67 -136
- package/lib/cjs/services/preference/index.js +25 -51
- package/lib/cjs/services/private_message/index.js +98 -177
- package/lib/cjs/services/score/index.js +22 -46
- package/lib/cjs/services/sso/index.js +17 -32
- package/lib/cjs/services/suggestion/index.js +23 -57
- package/lib/cjs/services/tag/index.js +72 -119
- package/lib/cjs/services/user/index.js +420 -767
- package/lib/cjs/services/webhook/index.js +4 -7
- package/lib/cjs/types/baseParams.js +3 -0
- package/lib/cjs/types/category.js +3 -0
- package/lib/cjs/types/comment.js +3 -0
- package/lib/cjs/types/customAdv.js +3 -0
- package/lib/cjs/types/customPage.js +3 -0
- package/lib/cjs/types/embed.js +3 -0
- package/lib/cjs/types/feed.js +3 -0
- package/lib/cjs/types/feedObject.js +3 -0
- package/lib/cjs/types/incubator.js +3 -0
- package/lib/cjs/types/index.js +91 -1
- package/lib/cjs/types/legalPage.js +3 -0
- package/lib/cjs/types/media.js +29 -0
- package/lib/cjs/types/moderation.js +3 -0
- package/lib/cjs/types/notification.js +3 -0
- package/lib/cjs/types/privateMessage.js +3 -0
- package/lib/cjs/types/prize.js +3 -0
- package/lib/cjs/types/sso.js +3 -0
- package/lib/cjs/types/tag.js +3 -0
- package/lib/cjs/types/user.js +3 -0
- package/lib/cjs/utils/apiRequest.js +2 -1
- package/lib/esm/index.js +36 -0
- package/lib/esm/services/category/index.js +168 -286
- package/lib/esm/services/comment/index.js +107 -186
- package/lib/esm/services/custom_adv/index.js +31 -51
- package/lib/esm/services/custom_page/index.js +32 -52
- package/lib/esm/services/data_portability/index.js +18 -43
- package/lib/esm/services/embed/index.js +90 -151
- package/lib/esm/services/feature/index.js +8 -16
- package/lib/esm/services/feed/index.js +46 -81
- package/lib/esm/services/feed_object/index.js +339 -505
- package/lib/esm/services/incubator/index.js +64 -116
- package/lib/esm/services/insight/index.js +51 -94
- package/lib/esm/services/legal_page/index.js +60 -101
- package/lib/esm/services/locality/index.js +14 -30
- package/lib/esm/services/loyalty/index.js +92 -154
- package/lib/esm/services/media/index.js +80 -122
- package/lib/esm/services/moderation/index.js +65 -103
- package/lib/esm/services/notification/index.js +67 -136
- package/lib/esm/services/preference/index.js +25 -51
- package/lib/esm/services/private_message/index.js +98 -177
- package/lib/esm/services/score/index.js +22 -46
- package/lib/esm/services/sso/index.js +17 -32
- package/lib/esm/services/suggestion/index.js +23 -57
- package/lib/esm/services/tag/index.js +72 -119
- package/lib/esm/services/user/index.js +420 -767
- package/lib/esm/services/webhook/index.js +4 -7
- package/lib/esm/types/baseParams.js +3 -0
- package/lib/esm/types/category.js +3 -0
- package/lib/esm/types/comment.js +3 -0
- package/lib/esm/types/customAdv.js +3 -0
- package/lib/esm/types/customPage.js +3 -0
- package/lib/esm/types/embed.js +3 -0
- package/lib/esm/types/feed.js +3 -0
- package/lib/esm/types/feedObject.js +3 -0
- package/lib/esm/types/incubator.js +3 -0
- package/lib/esm/types/index.js +91 -1
- package/lib/esm/types/legalPage.js +3 -0
- package/lib/esm/types/media.js +29 -0
- package/lib/esm/types/moderation.js +3 -0
- package/lib/esm/types/notification.js +3 -0
- package/lib/esm/types/privateMessage.js +3 -0
- package/lib/esm/types/prize.js +3 -0
- package/lib/esm/types/sso.js +3 -0
- package/lib/esm/types/tag.js +3 -0
- package/lib/esm/types/user.js +3 -0
- package/lib/esm/utils/apiRequest.js +2 -1
- package/lib/types/index.d.ts +2 -2
- package/lib/types/index.d.ts.map +1 -1
- package/lib/types/services/category/index.d.ts +114 -42
- package/lib/types/services/category/index.d.ts.map +1 -1
- package/lib/types/services/comment/index.d.ts +74 -23
- package/lib/types/services/comment/index.d.ts.map +1 -1
- package/lib/types/services/custom_adv/index.d.ts +26 -9
- package/lib/types/services/custom_adv/index.d.ts.map +1 -1
- package/lib/types/services/custom_page/index.d.ts +26 -9
- package/lib/types/services/custom_page/index.d.ts.map +1 -1
- package/lib/types/services/data_portability/index.d.ts +19 -6
- package/lib/types/services/data_portability/index.d.ts.map +1 -1
- package/lib/types/services/embed/index.d.ts +62 -24
- package/lib/types/services/embed/index.d.ts.map +1 -1
- package/lib/types/services/feature/index.d.ts +11 -3
- package/lib/types/services/feature/index.d.ts.map +1 -1
- package/lib/types/services/feed/index.d.ts +37 -15
- package/lib/types/services/feed/index.d.ts.map +1 -1
- package/lib/types/services/feed_object/index.d.ts +229 -81
- package/lib/types/services/feed_object/index.d.ts.map +1 -1
- package/lib/types/services/incubator/index.d.ts +51 -18
- package/lib/types/services/incubator/index.d.ts.map +1 -1
- package/lib/types/services/insight/index.d.ts +44 -18
- package/lib/types/services/insight/index.d.ts.map +1 -1
- package/lib/types/services/legal_page/index.d.ts +46 -18
- package/lib/types/services/legal_page/index.d.ts.map +1 -1
- package/lib/types/services/locality/index.d.ts +17 -6
- package/lib/types/services/locality/index.d.ts.map +1 -1
- package/lib/types/services/loyalty/index.d.ts +70 -27
- package/lib/types/services/loyalty/index.d.ts.map +1 -1
- package/lib/types/services/media/index.d.ts +55 -18
- package/lib/types/services/media/index.d.ts.map +1 -1
- package/lib/types/services/moderation/index.d.ts +51 -18
- package/lib/types/services/moderation/index.d.ts.map +1 -1
- package/lib/types/services/notification/index.d.ts +63 -27
- package/lib/types/services/notification/index.d.ts.map +1 -1
- package/lib/types/services/preference/index.d.ts +28 -9
- package/lib/types/services/preference/index.d.ts.map +1 -1
- package/lib/types/services/private_message/index.d.ts +68 -24
- package/lib/types/services/private_message/index.d.ts.map +1 -1
- package/lib/types/services/score/index.d.ts +24 -9
- package/lib/types/services/score/index.d.ts.map +1 -1
- package/lib/types/services/sso/index.d.ts +18 -6
- package/lib/types/services/sso/index.d.ts.map +1 -1
- package/lib/types/services/suggestion/index.d.ts +29 -12
- package/lib/types/services/suggestion/index.d.ts.map +1 -1
- package/lib/types/services/tag/index.d.ts +57 -21
- package/lib/types/services/tag/index.d.ts.map +1 -1
- package/lib/types/services/user/index.d.ts +313 -114
- package/lib/types/services/user/index.d.ts.map +1 -1
- package/lib/types/services/webhook/index.d.ts +3 -4
- package/lib/types/services/webhook/index.d.ts.map +1 -1
- package/lib/types/tsconfig.build.tsbuildinfo +1 -1
- package/lib/types/types/baseParams.d.ts +23 -0
- package/lib/types/types/baseParams.d.ts.map +1 -0
- package/lib/types/types/category.d.ts +15 -0
- package/lib/types/types/category.d.ts.map +1 -0
- package/lib/types/types/comment.d.ts +51 -0
- package/lib/types/types/comment.d.ts.map +1 -0
- package/lib/types/types/customAdv.d.ts +19 -0
- package/lib/types/types/customAdv.d.ts.map +1 -0
- package/lib/types/types/customPage.d.ts +24 -0
- package/lib/types/types/customPage.d.ts.map +1 -0
- package/lib/types/types/embed.d.ts +26 -0
- package/lib/types/types/embed.d.ts.map +1 -0
- package/lib/types/types/feed.d.ts +11 -0
- package/lib/types/types/feed.d.ts.map +1 -0
- package/lib/types/types/feedObject.d.ts +56 -0
- package/lib/types/types/feedObject.d.ts.map +1 -0
- package/lib/types/types/incubator.d.ts +33 -0
- package/lib/types/types/incubator.d.ts.map +1 -0
- package/lib/types/types/index.d.ts +19 -1
- package/lib/types/types/index.d.ts.map +1 -1
- package/lib/types/types/legalPage.d.ts +19 -0
- package/lib/types/types/legalPage.d.ts.map +1 -0
- package/lib/types/types/media.d.ts +80 -0
- package/lib/types/types/media.d.ts.map +1 -0
- package/lib/types/types/moderation.d.ts +23 -0
- package/lib/types/types/moderation.d.ts.map +1 -0
- package/lib/types/types/notification.d.ts +31 -0
- package/lib/types/types/notification.d.ts.map +1 -0
- package/lib/types/types/privateMessage.d.ts +176 -0
- package/lib/types/types/privateMessage.d.ts.map +1 -0
- package/lib/types/types/prize.d.ts +47 -0
- package/lib/types/types/prize.d.ts.map +1 -0
- package/lib/types/types/sso.d.ts +12 -0
- package/lib/types/types/sso.d.ts.map +1 -0
- package/lib/types/types/tag.d.ts +39 -0
- package/lib/types/types/tag.d.ts.map +1 -0
- package/lib/types/types/user.d.ts +105 -0
- package/lib/types/types/user.d.ts.map +1 -0
- package/lib/types/utils/apiRequest.d.ts +1 -1
- package/lib/types/utils/apiRequest.d.ts.map +1 -1
- package/lib/umd/api-services.js +1 -1
- package/lib/umd/api-services.js.map +1 -1
- package/package.json +4 -4
|
@@ -1,88 +1,236 @@
|
|
|
1
|
+
import { BaseGetParams, FeedObjCreateParams, FeedObjectPollVotesSearch, FeedObjGetParams, SCPaginatedResponse } from '../../types';
|
|
2
|
+
import { SCFeedObjectFollowingStatusType, SCFeedObjectHideStatusType, SCFeedObjectSuspendedStatusType, SCFeedObjectType, SCFeedObjectTypologyType, SCFlagType, SCFlagTypeEnum, SCPollVoteType, SCUserType, SCVoteType } from '@selfcommunity/types';
|
|
1
3
|
export interface FeedObjectApiClientInterface {
|
|
2
|
-
getAllFeedObjects(type:
|
|
3
|
-
getUncommentedFeedObjects(type:
|
|
4
|
-
searchFeedObject(type:
|
|
5
|
-
createFeedObject(type:
|
|
6
|
-
getSpecificFeedObject(type:
|
|
7
|
-
updateFeedObject(type:
|
|
8
|
-
deleteFeedObject(type:
|
|
9
|
-
feedObjectContributorsList(id: number,
|
|
10
|
-
feedObjectSharesList(type:
|
|
11
|
-
feedObjectUserSharesList(type:
|
|
12
|
-
restoreFeedObject(type:
|
|
13
|
-
relatedFeedObjects(type:
|
|
14
|
-
voteFeedObject(type:
|
|
15
|
-
feedObjectVotes(type:
|
|
16
|
-
feedObjectPollVote(type:
|
|
17
|
-
feedObjectPollVotesList(type:
|
|
18
|
-
followFeedObject(type:
|
|
19
|
-
feedObjectFollowingList(type:
|
|
20
|
-
checkIfFollowingFeedObject(type:
|
|
21
|
-
suspendFeedObject(type:
|
|
22
|
-
checkIfSuspendedFeedObject(type:
|
|
23
|
-
feedObjectSuspendedList(type:
|
|
24
|
-
flagFeedObject(type:
|
|
25
|
-
feedObjectFlagList(type:
|
|
26
|
-
feedObjectFlagStatus(type:
|
|
27
|
-
hideFeedObject(type:
|
|
28
|
-
feedObjectHideStatus(type:
|
|
4
|
+
getAllFeedObjects(type: SCFeedObjectTypologyType, params?: FeedObjGetParams): Promise<SCPaginatedResponse<SCFeedObjectType>>;
|
|
5
|
+
getUncommentedFeedObjects(type: SCFeedObjectTypologyType, params?: BaseGetParams): Promise<SCPaginatedResponse<SCFeedObjectType>>;
|
|
6
|
+
searchFeedObject(type: SCFeedObjectTypologyType): Promise<SCPaginatedResponse<SCFeedObjectType>>;
|
|
7
|
+
createFeedObject(type: SCFeedObjectTypologyType, data: FeedObjCreateParams): Promise<SCFeedObjectType>;
|
|
8
|
+
getSpecificFeedObject(type: SCFeedObjectTypologyType, id: number): Promise<SCFeedObjectType>;
|
|
9
|
+
updateFeedObject(type: SCFeedObjectTypologyType, id: number, data: FeedObjCreateParams): Promise<SCFeedObjectType>;
|
|
10
|
+
deleteFeedObject(type: SCFeedObjectTypologyType, id: number): Promise<any>;
|
|
11
|
+
feedObjectContributorsList(type: SCFeedObjectTypologyType, id: number, params?: BaseGetParams): Promise<SCPaginatedResponse<SCUserType>>;
|
|
12
|
+
feedObjectSharesList(type: SCFeedObjectTypologyType, id: number, params?: BaseGetParams): Promise<SCPaginatedResponse<SCFeedObjectType>>;
|
|
13
|
+
feedObjectUserSharesList(type: SCFeedObjectTypologyType, id: number, params?: BaseGetParams): Promise<SCPaginatedResponse<SCUserType>>;
|
|
14
|
+
restoreFeedObject(type: SCFeedObjectTypologyType, id: number): Promise<any>;
|
|
15
|
+
relatedFeedObjects(type: SCFeedObjectTypologyType, id: number, params?: BaseGetParams): Promise<SCPaginatedResponse<SCFeedObjectType>>;
|
|
16
|
+
voteFeedObject(type: SCFeedObjectTypologyType, id: number): Promise<any>;
|
|
17
|
+
feedObjectVotes(type: SCFeedObjectTypologyType, id: number, params?: BaseGetParams): Promise<SCPaginatedResponse<SCVoteType>>;
|
|
18
|
+
feedObjectPollVote(type: SCFeedObjectTypologyType, id: number, choice: number): Promise<any>;
|
|
19
|
+
feedObjectPollVotesList(type: SCFeedObjectTypologyType, id: number, params?: FeedObjectPollVotesSearch): Promise<SCPaginatedResponse<SCPollVoteType>>;
|
|
20
|
+
followFeedObject(type: SCFeedObjectTypologyType, id: number): Promise<any>;
|
|
21
|
+
feedObjectFollowingList(type: SCFeedObjectTypologyType, params?: BaseGetParams): Promise<SCPaginatedResponse<SCFeedObjectType>>;
|
|
22
|
+
checkIfFollowingFeedObject(type: SCFeedObjectTypologyType, id: number): Promise<SCPaginatedResponse<SCFeedObjectFollowingStatusType>>;
|
|
23
|
+
suspendFeedObject(type: SCFeedObjectTypologyType, id: number): Promise<any>;
|
|
24
|
+
checkIfSuspendedFeedObject(type: SCFeedObjectTypologyType, id: number): Promise<SCPaginatedResponse<SCFeedObjectSuspendedStatusType>>;
|
|
25
|
+
feedObjectSuspendedList(type: SCFeedObjectTypologyType, params?: BaseGetParams): Promise<SCPaginatedResponse<SCFeedObjectType>>;
|
|
26
|
+
flagFeedObject(type: SCFeedObjectTypologyType, id: number, flag_type: SCFlagTypeEnum): Promise<any>;
|
|
27
|
+
feedObjectFlagList(type: SCFeedObjectTypologyType, id: number): Promise<SCPaginatedResponse<SCFlagType>>;
|
|
28
|
+
feedObjectFlagStatus(type: SCFeedObjectTypologyType, id: number): Promise<SCPaginatedResponse<SCFlagType>>;
|
|
29
|
+
hideFeedObject(type: SCFeedObjectTypologyType, id: number): Promise<any>;
|
|
30
|
+
feedObjectHideStatus(type: SCFeedObjectTypologyType, id: number): Promise<SCPaginatedResponse<SCFeedObjectHideStatusType>>;
|
|
29
31
|
}
|
|
32
|
+
/**
|
|
33
|
+
* Contains all the endpoints needed to manage feed objs (discussions-posts-statuses).
|
|
34
|
+
*/
|
|
30
35
|
export declare class FeedObjectApiClient {
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
static
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
static
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
static
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
static
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
36
|
+
/**
|
|
37
|
+
* This endpoint retrieves all feed objs
|
|
38
|
+
* @param type
|
|
39
|
+
* @param params
|
|
40
|
+
*/
|
|
41
|
+
static getAllFeedObjects(type: SCFeedObjectTypologyType, params?: FeedObjGetParams): Promise<SCPaginatedResponse<SCFeedObjectType>>;
|
|
42
|
+
/**
|
|
43
|
+
* This endpoint retrieves all uncommented feed objs
|
|
44
|
+
* @param type
|
|
45
|
+
* @param params
|
|
46
|
+
*/
|
|
47
|
+
static getUncommentedFeedObjects(type: SCFeedObjectTypologyType, params?: BaseGetParams): Promise<SCPaginatedResponse<SCFeedObjectType>>;
|
|
48
|
+
/**
|
|
49
|
+
* This endpoint performs search operation to feed objs
|
|
50
|
+
* @param type
|
|
51
|
+
*/
|
|
52
|
+
static searchFeedObject(type: SCFeedObjectTypologyType): Promise<SCPaginatedResponse<SCFeedObjectType>>;
|
|
53
|
+
/**
|
|
54
|
+
* This endpoint creates a feed obj
|
|
55
|
+
* @param type
|
|
56
|
+
* @param data
|
|
57
|
+
*/
|
|
58
|
+
static createFeedObject(type: SCFeedObjectTypologyType, data: FeedObjCreateParams): Promise<SCFeedObjectType>;
|
|
59
|
+
/**
|
|
60
|
+
* This endpoint retrieves a specific feed obj using ID
|
|
61
|
+
* @param type
|
|
62
|
+
* @param id
|
|
63
|
+
*/
|
|
64
|
+
static getSpecificFeedObject(type: SCFeedObjectTypologyType, id: number): Promise<SCFeedObjectType>;
|
|
65
|
+
/**
|
|
66
|
+
* This endpoint updates a specific feed obj
|
|
67
|
+
* @param type
|
|
68
|
+
* @param id
|
|
69
|
+
* @param data
|
|
70
|
+
*/
|
|
71
|
+
static updateFeedObject(type: SCFeedObjectTypologyType, id: number, data: FeedObjCreateParams): Promise<SCFeedObjectType>;
|
|
72
|
+
/**
|
|
73
|
+
* This endpoint deletes a specific feed obj
|
|
74
|
+
* @param type
|
|
75
|
+
* @param id
|
|
76
|
+
*/
|
|
77
|
+
static deleteFeedObject(type: SCFeedObjectTypologyType, id: number): Promise<any>;
|
|
78
|
+
/**
|
|
79
|
+
* This endpoint retrieves all contributors for a specific feed obj
|
|
80
|
+
* @param type
|
|
81
|
+
* @param id
|
|
82
|
+
* @param params
|
|
83
|
+
*/
|
|
84
|
+
static feedObjectContributorsList(type: SCFeedObjectTypologyType, id: number, params?: BaseGetParams): Promise<SCPaginatedResponse<SCUserType>>;
|
|
85
|
+
/**
|
|
86
|
+
* This endpoint retrieves all shares for a specific feed obj
|
|
87
|
+
* @param type
|
|
88
|
+
* @param id
|
|
89
|
+
* @param params
|
|
90
|
+
*/
|
|
91
|
+
static feedObjectSharesList(type: SCFeedObjectTypologyType, id: number, params?: BaseGetParams): Promise<SCPaginatedResponse<SCFeedObjectType>>;
|
|
92
|
+
/**
|
|
93
|
+
* This endpoint retrieves all shares users for a specific feed obj
|
|
94
|
+
* @param type
|
|
95
|
+
* @param id
|
|
96
|
+
* @param params
|
|
97
|
+
*/
|
|
98
|
+
static feedObjectUserSharesList(type: SCFeedObjectTypologyType, id: number, params?: BaseGetParams): Promise<SCPaginatedResponse<SCUserType>>;
|
|
99
|
+
/**
|
|
100
|
+
*
|
|
101
|
+
* @param type
|
|
102
|
+
* @param id
|
|
103
|
+
*/
|
|
104
|
+
static restoreFeedObject(type: SCFeedObjectTypologyType, id: number): Promise<any>;
|
|
105
|
+
/**
|
|
106
|
+
* This endpoint restores a feed obj
|
|
107
|
+
* @param type
|
|
108
|
+
* @param id
|
|
109
|
+
* @param params
|
|
110
|
+
*/
|
|
111
|
+
static relatedFeedObjects(type: SCFeedObjectTypologyType, id: number, params?: BaseGetParams): Promise<SCPaginatedResponse<SCFeedObjectType>>;
|
|
112
|
+
/**
|
|
113
|
+
* This endpoint upvotes a specific feed obj
|
|
114
|
+
* @param type
|
|
115
|
+
* @param id
|
|
116
|
+
*/
|
|
117
|
+
static voteFeedObject(type: SCFeedObjectTypologyType, id: number): Promise<any>;
|
|
118
|
+
/**
|
|
119
|
+
* This endpoint retrieves all votes for a specific feed obj
|
|
120
|
+
* @param type
|
|
121
|
+
* @param id
|
|
122
|
+
* @param params
|
|
123
|
+
*/
|
|
124
|
+
static feedObjectVotes(type: SCFeedObjectTypologyType, id: number, params?: BaseGetParams): Promise<SCPaginatedResponse<SCVoteType>>;
|
|
125
|
+
/**
|
|
126
|
+
* This endpoint upvotes a specific poll choice in a feed obj
|
|
127
|
+
* @param type It can be only "discussion" or "post".
|
|
128
|
+
* @param id
|
|
129
|
+
* @param choice
|
|
130
|
+
*/
|
|
131
|
+
static feedObjectPollVote(type: SCFeedObjectTypologyType, id: number, choice: number): Promise<any>;
|
|
132
|
+
/**
|
|
133
|
+
* This endpoint retrieves all poll votes for a specific feed obj
|
|
134
|
+
* @param type It can be only "discussion" or "post".
|
|
135
|
+
* @param id
|
|
136
|
+
* @param params
|
|
137
|
+
*/
|
|
138
|
+
static feedObjectPollVotesList(type: SCFeedObjectTypologyType, id: number, params?: FeedObjectPollVotesSearch): Promise<SCPaginatedResponse<SCPollVoteType>>;
|
|
139
|
+
/**
|
|
140
|
+
* This endpoint follows a feed obj
|
|
141
|
+
* @param type
|
|
142
|
+
* @param id
|
|
143
|
+
*/
|
|
144
|
+
static followFeedObject(type: SCFeedObjectTypologyType, id: number): Promise<any>;
|
|
145
|
+
/**
|
|
146
|
+
* This endpoint retrieves all feed objs followed by the authenticated user
|
|
147
|
+
* @param type
|
|
148
|
+
* @param params
|
|
149
|
+
*/
|
|
150
|
+
static feedObjectFollowingList(type: SCFeedObjectTypologyType, params?: BaseGetParams): Promise<SCPaginatedResponse<SCFeedObjectType>>;
|
|
151
|
+
/**
|
|
152
|
+
* This endpoint returns following = true if the feed obj (identified in path) is followed by the authenticated user
|
|
153
|
+
* @param type
|
|
154
|
+
* @param id
|
|
155
|
+
*/
|
|
156
|
+
static checkIfFollowingFeedObject(type: SCFeedObjectTypologyType, id: number): Promise<SCPaginatedResponse<SCFeedObjectFollowingStatusType>>;
|
|
157
|
+
/**
|
|
158
|
+
* This endpoint suspends the notifications for the selected feed obj
|
|
159
|
+
* @param type
|
|
160
|
+
* @param id
|
|
161
|
+
*/
|
|
162
|
+
static suspendFeedObject(type: SCFeedObjectTypologyType, id: number): Promise<any>;
|
|
163
|
+
/**
|
|
164
|
+
* This endpoint returns suspended = true if the notifications for the feed obj (identified in path) is suspended by the authenticated user
|
|
165
|
+
* @param type
|
|
166
|
+
* @param id
|
|
167
|
+
*/
|
|
168
|
+
static checkIfSuspendedFeedObject(type: SCFeedObjectTypologyType, id: number): Promise<SCPaginatedResponse<SCFeedObjectSuspendedStatusType>>;
|
|
169
|
+
/**
|
|
170
|
+
* This endpoint retrieves the list of feed obj which notifications are suspended by the authenticated user
|
|
171
|
+
* @param type
|
|
172
|
+
* @param params
|
|
173
|
+
*/
|
|
174
|
+
static feedObjectSuspendedList(type: SCFeedObjectTypologyType, params?: BaseGetParams): Promise<SCPaginatedResponse<SCFeedObjectType>>;
|
|
175
|
+
/**
|
|
176
|
+
* This endpoint flags a specific feed obj
|
|
177
|
+
* @param type
|
|
178
|
+
* @param id
|
|
179
|
+
* @param flag_type
|
|
180
|
+
*/
|
|
181
|
+
static flagFeedObject(type: SCFeedObjectTypologyType, id: number, flag_type: SCFlagTypeEnum): Promise<any>;
|
|
182
|
+
/**
|
|
183
|
+
* Retrieves, if exists, a flag for this contribute created by the authenticated user
|
|
184
|
+
* @param type
|
|
185
|
+
* @param id
|
|
186
|
+
*/
|
|
187
|
+
static feedObjectFlagStatus(type: SCFeedObjectTypologyType, id: number): Promise<SCPaginatedResponse<SCFlagType>>;
|
|
188
|
+
/**
|
|
189
|
+
* This endpoint retrieves a list of flags for a specific feed obj
|
|
190
|
+
* @param type
|
|
191
|
+
* @param id
|
|
192
|
+
*/
|
|
193
|
+
static feedObjectFlagList(type: SCFeedObjectTypologyType, id: number): Promise<SCPaginatedResponse<SCFlagType>>;
|
|
194
|
+
/**
|
|
195
|
+
* This endpoint hides the feed obj for the logged user. The feed obj must be in show state
|
|
196
|
+
* @param type
|
|
197
|
+
* @param id
|
|
198
|
+
*/
|
|
199
|
+
static hideFeedObject(type: SCFeedObjectTypologyType, id: number): Promise<any>;
|
|
200
|
+
/**
|
|
201
|
+
* This endpoint retrieves if the the feed obj has been hidden by the authenticated user (hidden = true)
|
|
202
|
+
* @param type
|
|
203
|
+
* @param id
|
|
204
|
+
*/
|
|
205
|
+
static feedObjectHideStatus(type: SCFeedObjectTypologyType, id: number): Promise<SCPaginatedResponse<SCFeedObjectHideStatusType>>;
|
|
58
206
|
}
|
|
59
207
|
export default class FeedObjectService {
|
|
60
|
-
static getAllFeedObjects(type:
|
|
61
|
-
static getUncommentedFeedObjects(type:
|
|
62
|
-
static searchFeedObject(type:
|
|
63
|
-
static createFeedObject(type:
|
|
64
|
-
static getSpecificFeedObject(type:
|
|
65
|
-
static updateFeedObject(type:
|
|
66
|
-
static deleteFeedObject(type:
|
|
67
|
-
static feedObjectContributorsList(type:
|
|
68
|
-
static feedObjectSharesList(type:
|
|
69
|
-
static feedObjectUserSharesList(type:
|
|
70
|
-
static restoreFeedObject(type:
|
|
71
|
-
static relatedFeedObjects(type:
|
|
72
|
-
static voteFeedObject(type:
|
|
73
|
-
static feedObjectVotes(type:
|
|
74
|
-
static feedObjectPollVote(type:
|
|
75
|
-
static feedObjectPollVotesList(type:
|
|
76
|
-
static followFeedObject(type:
|
|
77
|
-
static feedObjectFollowingList(type:
|
|
78
|
-
static checkIfFollowingFeedObject(type:
|
|
79
|
-
static suspendFeedObject(type:
|
|
80
|
-
static checkIfSuspendedFeedObject(type:
|
|
81
|
-
static feedObjectSuspendedList(type:
|
|
82
|
-
static flagFeedObject(type:
|
|
83
|
-
static feedObjectFlagList(type:
|
|
84
|
-
static feedObjectFlagStatus(type:
|
|
85
|
-
static hideFeedObject(type:
|
|
86
|
-
static feedObjectHideStatus(type:
|
|
208
|
+
static getAllFeedObjects(type: SCFeedObjectTypologyType, params?: FeedObjGetParams): Promise<SCPaginatedResponse<SCFeedObjectType>>;
|
|
209
|
+
static getUncommentedFeedObjects(type: SCFeedObjectTypologyType, params?: BaseGetParams): Promise<SCPaginatedResponse<SCFeedObjectType>>;
|
|
210
|
+
static searchFeedObject(type: SCFeedObjectTypologyType): Promise<SCPaginatedResponse<SCFeedObjectType>>;
|
|
211
|
+
static createFeedObject(type: SCFeedObjectTypologyType, data: FeedObjCreateParams): Promise<SCFeedObjectType>;
|
|
212
|
+
static getSpecificFeedObject(type: SCFeedObjectTypologyType, id: number): Promise<SCFeedObjectType>;
|
|
213
|
+
static updateFeedObject(type: SCFeedObjectTypologyType, id: number, data: FeedObjCreateParams): Promise<SCFeedObjectType>;
|
|
214
|
+
static deleteFeedObject(type: SCFeedObjectTypologyType, id: number): Promise<any>;
|
|
215
|
+
static feedObjectContributorsList(type: SCFeedObjectTypologyType, id: number, params?: BaseGetParams): Promise<SCPaginatedResponse<SCUserType>>;
|
|
216
|
+
static feedObjectSharesList(type: SCFeedObjectTypologyType, id: number, params?: BaseGetParams): Promise<SCPaginatedResponse<SCFeedObjectType>>;
|
|
217
|
+
static feedObjectUserSharesList(type: SCFeedObjectTypologyType, id: number, params?: BaseGetParams): Promise<SCPaginatedResponse<SCUserType>>;
|
|
218
|
+
static restoreFeedObject(type: SCFeedObjectTypologyType, id: number): Promise<any>;
|
|
219
|
+
static relatedFeedObjects(type: SCFeedObjectTypologyType, id: number, params?: BaseGetParams): Promise<SCPaginatedResponse<SCFeedObjectType>>;
|
|
220
|
+
static voteFeedObject(type: SCFeedObjectTypologyType, id: number): Promise<any>;
|
|
221
|
+
static feedObjectVotes(type: SCFeedObjectTypologyType, id: number, params?: BaseGetParams): Promise<SCPaginatedResponse<SCVoteType>>;
|
|
222
|
+
static feedObjectPollVote(type: SCFeedObjectTypologyType, id: number, choice: number): Promise<any>;
|
|
223
|
+
static feedObjectPollVotesList(type: SCFeedObjectTypologyType, id: number, params?: FeedObjectPollVotesSearch): Promise<SCPaginatedResponse<SCPollVoteType>>;
|
|
224
|
+
static followFeedObject(type: SCFeedObjectTypologyType, id: number): Promise<any>;
|
|
225
|
+
static feedObjectFollowingList(type: SCFeedObjectTypologyType, params?: BaseGetParams): Promise<SCPaginatedResponse<SCFeedObjectType>>;
|
|
226
|
+
static checkIfFollowingFeedObject(type: SCFeedObjectTypologyType, id: number): Promise<SCPaginatedResponse<SCFeedObjectFollowingStatusType>>;
|
|
227
|
+
static suspendFeedObject(type: SCFeedObjectTypologyType, id: number): Promise<any>;
|
|
228
|
+
static checkIfSuspendedFeedObject(type: SCFeedObjectTypologyType, id: number): Promise<SCPaginatedResponse<SCFeedObjectSuspendedStatusType>>;
|
|
229
|
+
static feedObjectSuspendedList(type: SCFeedObjectTypologyType, params?: BaseGetParams): Promise<SCPaginatedResponse<SCFeedObjectType>>;
|
|
230
|
+
static flagFeedObject(type: SCFeedObjectTypologyType, id: number, flag_type: SCFlagTypeEnum): Promise<any>;
|
|
231
|
+
static feedObjectFlagList(type: SCFeedObjectTypologyType, id: number): Promise<SCPaginatedResponse<SCFlagType>>;
|
|
232
|
+
static feedObjectFlagStatus(type: SCFeedObjectTypologyType, id: number): Promise<SCPaginatedResponse<SCFlagType>>;
|
|
233
|
+
static hideFeedObject(type: SCFeedObjectTypologyType, id: number): Promise<any>;
|
|
234
|
+
static feedObjectHideStatus(type: SCFeedObjectTypologyType, id: number): Promise<SCPaginatedResponse<SCFeedObjectHideStatusType>>;
|
|
87
235
|
}
|
|
88
236
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/services/feed_object/index.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/services/feed_object/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,aAAa,EAAE,mBAAmB,EAAE,yBAAyB,EAAE,gBAAgB,EAAE,mBAAmB,EAAC,MAAM,aAAa,CAAC;AAEjI,OAAO,EACL,+BAA+B,EAC/B,0BAA0B,EAC1B,+BAA+B,EAC/B,gBAAgB,EAChB,wBAAwB,EACxB,UAAU,EACV,cAAc,EACd,cAAc,EACd,UAAU,EACV,UAAU,EACX,MAAM,sBAAsB,CAAC;AAE9B,MAAM,WAAW,4BAA4B;IAC3C,iBAAiB,CAAC,IAAI,EAAE,wBAAwB,EAAE,MAAM,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,mBAAmB,CAAC,gBAAgB,CAAC,CAAC,CAAC;IAC7H,yBAAyB,CAAC,IAAI,EAAE,wBAAwB,EAAE,MAAM,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,mBAAmB,CAAC,gBAAgB,CAAC,CAAC,CAAC;IAClI,gBAAgB,CAAC,IAAI,EAAE,wBAAwB,GAAG,OAAO,CAAC,mBAAmB,CAAC,gBAAgB,CAAC,CAAC,CAAC;IACjG,gBAAgB,CAAC,IAAI,EAAE,wBAAwB,EAAE,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;IACvG,qBAAqB,CAAC,IAAI,EAAE,wBAAwB,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAC7F,gBAAgB,CAAC,IAAI,EAAE,wBAAwB,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;IACnH,gBAAgB,CAAC,IAAI,EAAE,wBAAwB,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAC3E,0BAA0B,CAAC,IAAI,EAAE,wBAAwB,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC,CAAC;IACzI,oBAAoB,CAAC,IAAI,EAAE,wBAAwB,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,mBAAmB,CAAC,gBAAgB,CAAC,CAAC,CAAC;IACzI,wBAAwB,CAAC,IAAI,EAAE,wBAAwB,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC,CAAC;IACvI,iBAAiB,CAAC,IAAI,EAAE,wBAAwB,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAC5E,kBAAkB,CAAC,IAAI,EAAE,wBAAwB,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,mBAAmB,CAAC,gBAAgB,CAAC,CAAC,CAAC;IACvI,cAAc,CAAC,IAAI,EAAE,wBAAwB,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IACzE,eAAe,CAAC,IAAI,EAAE,wBAAwB,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC,CAAC;IAC9H,kBAAkB,CAAC,IAAI,EAAE,wBAAwB,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAC7F,uBAAuB,CACrB,IAAI,EAAE,wBAAwB,EAC9B,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,yBAAyB,GACjC,OAAO,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC,CAAC;IAChD,gBAAgB,CAAC,IAAI,EAAE,wBAAwB,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAC3E,uBAAuB,CAAC,IAAI,EAAE,wBAAwB,EAAE,MAAM,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,mBAAmB,CAAC,gBAAgB,CAAC,CAAC,CAAC;IAChI,0BAA0B,CAAC,IAAI,EAAE,wBAAwB,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,+BAA+B,CAAC,CAAC,CAAC;IACtI,iBAAiB,CAAC,IAAI,EAAE,wBAAwB,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAC5E,0BAA0B,CAAC,IAAI,EAAE,wBAAwB,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,+BAA+B,CAAC,CAAC,CAAC;IACtI,uBAAuB,CAAC,IAAI,EAAE,wBAAwB,EAAE,MAAM,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,mBAAmB,CAAC,gBAAgB,CAAC,CAAC,CAAC;IAChI,cAAc,CAAC,IAAI,EAAE,wBAAwB,EAAE,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,cAAc,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IACpG,kBAAkB,CAAC,IAAI,EAAE,wBAAwB,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC,CAAC;IACzG,oBAAoB,CAAC,IAAI,EAAE,wBAAwB,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC,CAAC;IAC3G,cAAc,CAAC,IAAI,EAAE,wBAAwB,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IACzE,oBAAoB,CAAC,IAAI,EAAE,wBAAwB,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,0BAA0B,CAAC,CAAC,CAAC;CAC5H;AACD;;GAEG;AAEH,qBAAa,mBAAmB;IAC9B;;;;OAIG;IACH,MAAM,CAAC,iBAAiB,CAAC,IAAI,EAAE,wBAAwB,EAAE,MAAM,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,mBAAmB,CAAC,gBAAgB,CAAC,CAAC;IAKnI;;;;OAIG;IACH,MAAM,CAAC,yBAAyB,CAAC,IAAI,EAAE,wBAAwB,EAAE,MAAM,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,mBAAmB,CAAC,gBAAgB,CAAC,CAAC;IAKxI;;;OAGG;IACH,MAAM,CAAC,gBAAgB,CAAC,IAAI,EAAE,wBAAwB,GAAG,OAAO,CAAC,mBAAmB,CAAC,gBAAgB,CAAC,CAAC;IAIvG;;;;OAIG;IACH,MAAM,CAAC,gBAAgB,CAAC,IAAI,EAAE,wBAAwB,EAAE,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAI7G;;;;OAIG;IACH,MAAM,CAAC,qBAAqB,CAAC,IAAI,EAAE,wBAAwB,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAInG;;;;;OAKG;IACH,MAAM,CAAC,gBAAgB,CAAC,IAAI,EAAE,wBAAwB,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAIzH;;;;OAIG;IACH,MAAM,CAAC,gBAAgB,CAAC,IAAI,EAAE,wBAAwB,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAIjF;;;;;OAKG;IACH,MAAM,CAAC,0BAA0B,CAAC,IAAI,EAAE,wBAAwB,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;IAK/I;;;;;OAKG;IACH,MAAM,CAAC,oBAAoB,CAAC,IAAI,EAAE,wBAAwB,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,mBAAmB,CAAC,gBAAgB,CAAC,CAAC;IAK/I;;;;;OAKG;IACH,MAAM,CAAC,wBAAwB,CAAC,IAAI,EAAE,wBAAwB,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;IAK7I;;;;OAIG;IACH,MAAM,CAAC,iBAAiB,CAAC,IAAI,EAAE,wBAAwB,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAIlF;;;;;OAKG;IACH,MAAM,CAAC,kBAAkB,CAAC,IAAI,EAAE,wBAAwB,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,mBAAmB,CAAC,gBAAgB,CAAC,CAAC;IAK7I;;;;OAIG;IACH,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,wBAAwB,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAI/E;;;;;OAKG;IACH,MAAM,CAAC,eAAe,CAAC,IAAI,EAAE,wBAAwB,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;IAKpI;;;;;OAKG;IACH,MAAM,CAAC,kBAAkB,CAAC,IAAI,EAAE,wBAAwB,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAInG;;;;;OAKG;IACH,MAAM,CAAC,uBAAuB,CAC5B,IAAI,EAAE,wBAAwB,EAC9B,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,yBAAyB,GACjC,OAAO,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC;IAK/C;;;;OAIG;IACH,MAAM,CAAC,gBAAgB,CAAC,IAAI,EAAE,wBAAwB,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAIjF;;;;OAIG;IACH,MAAM,CAAC,uBAAuB,CAAC,IAAI,EAAE,wBAAwB,EAAE,MAAM,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,mBAAmB,CAAC,gBAAgB,CAAC,CAAC;IAKtI;;;;OAIG;IACH,MAAM,CAAC,0BAA0B,CAAC,IAAI,EAAE,wBAAwB,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,+BAA+B,CAAC,CAAC;IAI5I;;;;OAIG;IACH,MAAM,CAAC,iBAAiB,CAAC,IAAI,EAAE,wBAAwB,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAIlF;;;;OAIG;IACH,MAAM,CAAC,0BAA0B,CAAC,IAAI,EAAE,wBAAwB,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,+BAA+B,CAAC,CAAC;IAO5I;;;;OAIG;IACH,MAAM,CAAC,uBAAuB,CAAC,IAAI,EAAE,wBAAwB,EAAE,MAAM,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,mBAAmB,CAAC,gBAAgB,CAAC,CAAC;IAQtI;;;;;OAKG;IACH,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,wBAAwB,EAAE,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,cAAc,GAAG,OAAO,CAAC,GAAG,CAAC;IAI1G;;;;OAIG;IACH,MAAM,CAAC,oBAAoB,CAAC,IAAI,EAAE,wBAAwB,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;IAIjH;;;;OAIG;IACH,MAAM,CAAC,kBAAkB,CAAC,IAAI,EAAE,wBAAwB,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;IAI/G;;;;OAIG;IACH,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,wBAAwB,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAI/E;;;;OAIG;IACH,MAAM,CAAC,oBAAoB,CAAC,IAAI,EAAE,wBAAwB,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,0BAA0B,CAAC,CAAC;CAGlI;AAED,MAAM,CAAC,OAAO,OAAO,iBAAiB;WACvB,iBAAiB,CAAC,IAAI,EAAE,wBAAwB,EAAE,MAAM,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,mBAAmB,CAAC,gBAAgB,CAAC,CAAC;WAI5H,yBAAyB,CAAC,IAAI,EAAE,wBAAwB,EAAE,MAAM,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,mBAAmB,CAAC,gBAAgB,CAAC,CAAC;WAIjI,gBAAgB,CAAC,IAAI,EAAE,wBAAwB,GAAG,OAAO,CAAC,mBAAmB,CAAC,gBAAgB,CAAC,CAAC;WAIhG,gBAAgB,CAAC,IAAI,EAAE,wBAAwB,EAAE,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC,gBAAgB,CAAC;WAItG,qBAAqB,CAAC,IAAI,EAAE,wBAAwB,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC;WAI5F,gBAAgB,CAAC,IAAI,EAAE,wBAAwB,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC,gBAAgB,CAAC;WAIlH,gBAAgB,CAAC,IAAI,EAAE,wBAAwB,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;WAI1E,0BAA0B,CACrC,IAAI,EAAE,wBAAwB,EAC9B,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,aAAa,GACrB,OAAO,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;WAI9B,oBAAoB,CAC/B,IAAI,EAAE,wBAAwB,EAC9B,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,aAAa,GACrB,OAAO,CAAC,mBAAmB,CAAC,gBAAgB,CAAC,CAAC;WAIpC,wBAAwB,CACnC,IAAI,EAAE,wBAAwB,EAC9B,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,aAAa,GACrB,OAAO,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;WAI9B,iBAAiB,CAAC,IAAI,EAAE,wBAAwB,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;WAI3E,kBAAkB,CAC7B,IAAI,EAAE,wBAAwB,EAC9B,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,aAAa,GACrB,OAAO,CAAC,mBAAmB,CAAC,gBAAgB,CAAC,CAAC;WAIpC,cAAc,CAAC,IAAI,EAAE,wBAAwB,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;WAGxE,eAAe,CAAC,IAAI,EAAE,wBAAwB,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;WAG7H,kBAAkB,CAAC,IAAI,EAAE,wBAAwB,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;WAI5F,uBAAuB,CAClC,IAAI,EAAE,wBAAwB,EAC9B,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,yBAAyB,GACjC,OAAO,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC;WAIlC,gBAAgB,CAAC,IAAI,EAAE,wBAAwB,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;WAI1E,uBAAuB,CAAC,IAAI,EAAE,wBAAwB,EAAE,MAAM,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,mBAAmB,CAAC,gBAAgB,CAAC,CAAC;WAI/H,0BAA0B,CAAC,IAAI,EAAE,wBAAwB,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,+BAA+B,CAAC,CAAC;WAIrI,iBAAiB,CAAC,IAAI,EAAE,wBAAwB,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;WAI3E,0BAA0B,CAAC,IAAI,EAAE,wBAAwB,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,+BAA+B,CAAC,CAAC;WAGrI,uBAAuB,CAAC,IAAI,EAAE,wBAAwB,EAAE,MAAM,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,mBAAmB,CAAC,gBAAgB,CAAC,CAAC;WAI/H,cAAc,CAAC,IAAI,EAAE,wBAAwB,EAAE,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,cAAc,GAAG,OAAO,CAAC,GAAG,CAAC;WAInG,kBAAkB,CAAC,IAAI,EAAE,wBAAwB,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;WAIxG,oBAAoB,CAAC,IAAI,EAAE,wBAAwB,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;WAG1G,cAAc,CAAC,IAAI,EAAE,wBAAwB,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;WAIxE,oBAAoB,CAAC,IAAI,EAAE,wBAAwB,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,0BAA0B,CAAC,CAAC;CAGxI"}
|
|
@@ -1,28 +1,61 @@
|
|
|
1
|
+
import { IncubatorCreateParams, IncubatorSearchParams, SCPaginatedResponse } from '../../types';
|
|
2
|
+
import { SCIncubatorSubscriptionType, SCIncubatorType, SCUserType } from '@selfcommunity/types';
|
|
1
3
|
export interface IncubatorApiClientInterface {
|
|
2
|
-
getAllIncubators(): Promise<
|
|
3
|
-
searchIncubators(): Promise<
|
|
4
|
-
getSpecificIncubator(id: number): Promise<
|
|
5
|
-
createIncubator(): Promise<
|
|
6
|
-
getIncubatorSubscribers(id: number): Promise<
|
|
4
|
+
getAllIncubators(params?: IncubatorSearchParams): Promise<SCPaginatedResponse<SCIncubatorType>>;
|
|
5
|
+
searchIncubators(params?: IncubatorSearchParams): Promise<SCPaginatedResponse<SCIncubatorType>>;
|
|
6
|
+
getSpecificIncubator(id: number): Promise<SCIncubatorType>;
|
|
7
|
+
createIncubator(data: IncubatorCreateParams): Promise<SCIncubatorType>;
|
|
8
|
+
getIncubatorSubscribers(id: number): Promise<SCPaginatedResponse<SCUserType>>;
|
|
7
9
|
subscribeToIncubator(id: number): Promise<any>;
|
|
8
|
-
checkIncubatorSubscription(id: number): Promise<
|
|
10
|
+
checkIncubatorSubscription(id: number): Promise<SCIncubatorSubscriptionType>;
|
|
9
11
|
}
|
|
12
|
+
/**
|
|
13
|
+
* Contains all the endpoints needed to manage incubators.
|
|
14
|
+
*/
|
|
10
15
|
export declare class IncubatorApiClient {
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
static
|
|
16
|
+
/**
|
|
17
|
+
* This endpoint retrieves all incubators.
|
|
18
|
+
* @param params
|
|
19
|
+
*/
|
|
20
|
+
static getAllIncubators(params?: IncubatorSearchParams): Promise<SCPaginatedResponse<SCIncubatorType>>;
|
|
21
|
+
/**
|
|
22
|
+
* This endpoint performs search od Incubators
|
|
23
|
+
* @param params
|
|
24
|
+
*/
|
|
25
|
+
static searchIncubators(params?: IncubatorSearchParams): Promise<SCPaginatedResponse<SCIncubatorType>>;
|
|
26
|
+
/**
|
|
27
|
+
* This endpoint retrieves a specific incubator.
|
|
28
|
+
* @param id
|
|
29
|
+
*/
|
|
30
|
+
static getSpecificIncubator(id: number): Promise<SCIncubatorType>;
|
|
31
|
+
/**
|
|
32
|
+
* This endpoint creates an incubator.
|
|
33
|
+
* @param data
|
|
34
|
+
*/
|
|
35
|
+
static createIncubator(data: IncubatorCreateParams): Promise<SCIncubatorType>;
|
|
36
|
+
/**
|
|
37
|
+
* This endpoint returns all subscribers of a specific incubator.
|
|
38
|
+
* @param id
|
|
39
|
+
*/
|
|
40
|
+
static getIncubatorSubscribers(id: number): Promise<SCPaginatedResponse<SCUserType>>;
|
|
41
|
+
/**
|
|
42
|
+
* This endpoint subscribes to an incubator.
|
|
43
|
+
* @param id
|
|
44
|
+
*/
|
|
16
45
|
static subscribeToIncubator(id: number): Promise<any>;
|
|
17
|
-
|
|
46
|
+
/**
|
|
47
|
+
* This endpoint returns subscribed = true if the incubator (identified in path) is subscribed by the authenticated user.
|
|
48
|
+
* @param id
|
|
49
|
+
*/
|
|
50
|
+
static checkIncubatorSubscription(id: number): Promise<SCIncubatorSubscriptionType>;
|
|
18
51
|
}
|
|
19
52
|
export default class IncubatorService {
|
|
20
|
-
static getAllIncubators(): Promise<
|
|
21
|
-
static searchIncubators(): Promise<
|
|
22
|
-
static getSpecificIncubator(id: number): Promise<
|
|
23
|
-
static createIncubator(): Promise<
|
|
24
|
-
static getIncubatorSubscribers(id: number): Promise<
|
|
53
|
+
static getAllIncubators(params?: IncubatorSearchParams): Promise<SCPaginatedResponse<SCIncubatorType>>;
|
|
54
|
+
static searchIncubators(params?: IncubatorSearchParams): Promise<SCPaginatedResponse<SCIncubatorType>>;
|
|
55
|
+
static getSpecificIncubator(id: number): Promise<SCIncubatorType>;
|
|
56
|
+
static createIncubator(data: IncubatorCreateParams): Promise<SCIncubatorType>;
|
|
57
|
+
static getIncubatorSubscribers(id: number): Promise<SCPaginatedResponse<SCUserType>>;
|
|
25
58
|
static subscribeToIncubator(id: number): Promise<any>;
|
|
26
|
-
static checkIncubatorSubscription(id: number): Promise<
|
|
59
|
+
static checkIncubatorSubscription(id: number): Promise<SCIncubatorSubscriptionType>;
|
|
27
60
|
}
|
|
28
61
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/services/incubator/index.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/services/incubator/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,qBAAqB,EAAE,qBAAqB,EAAE,mBAAmB,EAAC,MAAM,aAAa,CAAC;AAG9F,OAAO,EAAC,2BAA2B,EAAE,eAAe,EAAE,UAAU,EAAC,MAAM,sBAAsB,CAAC;AAE9F,MAAM,WAAW,2BAA2B;IAC1C,gBAAgB,CAAC,MAAM,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC,CAAC;IAChG,gBAAgB,CAAC,MAAM,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC,CAAC;IAChG,oBAAoB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IAC3D,eAAe,CAAC,IAAI,EAAE,qBAAqB,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IACvE,uBAAuB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC,CAAC;IAC9E,oBAAoB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAC/C,0BAA0B,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,2BAA2B,CAAC,CAAC;CAC9E;AACD;;GAEG;AAEH,qBAAa,kBAAkB;IAC7B;;;OAGG;IACH,MAAM,CAAC,gBAAgB,CAAC,MAAM,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC;IAKtG;;;OAGG;IACH,MAAM,CAAC,gBAAgB,CAAC,MAAM,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC;IAKtG;;;OAGG;IACH,MAAM,CAAC,oBAAoB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC;IAIjE;;;OAGG;IACH,MAAM,CAAC,eAAe,CAAC,IAAI,EAAE,qBAAqB,GAAG,OAAO,CAAC,eAAe,CAAC;IAI7E;;;OAGG;IACH,MAAM,CAAC,uBAAuB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;IAIpF;;;OAGG;IACH,MAAM,CAAC,oBAAoB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAIrD;;;OAGG;IACH,MAAM,CAAC,0BAA0B,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,2BAA2B,CAAC;CAGpF;AAED,MAAM,CAAC,OAAO,OAAO,gBAAgB;WACtB,gBAAgB,CAAC,MAAM,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC;WAI/F,gBAAgB,CAAC,MAAM,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC;WAI/F,oBAAoB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC;WAG1D,eAAe,CAAC,IAAI,EAAE,qBAAqB,GAAG,OAAO,CAAC,eAAe,CAAC;WAItE,uBAAuB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;WAI7E,oBAAoB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;WAI9C,0BAA0B,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,2BAA2B,CAAC;CAG1F"}
|
|
@@ -1,25 +1,51 @@
|
|
|
1
|
+
import { SCPaginatedResponse } from '../../types';
|
|
2
|
+
import { SCContributionInsightCountersType, SCContributionInsightType, SCEmbedInsightCountersType, SCEmbedInsightType, SCUsersInsightCountersType, SCUsersInsightType } from '@selfcommunity/types';
|
|
1
3
|
export interface InsightApiClientInterface {
|
|
2
|
-
getBestContributionInsight(): Promise<
|
|
3
|
-
getBestEmbedInsight(): Promise<
|
|
4
|
-
getBestUsersInsight(): Promise<
|
|
5
|
-
getContributionsInsightCounters(): Promise<
|
|
6
|
-
getEmbedsInsightCounters(id: number): Promise<
|
|
7
|
-
getUsersInsightCounters(id: number): Promise<
|
|
4
|
+
getBestContributionInsight(): Promise<SCPaginatedResponse<SCContributionInsightType>>;
|
|
5
|
+
getBestEmbedInsight(): Promise<SCPaginatedResponse<SCEmbedInsightType>>;
|
|
6
|
+
getBestUsersInsight(): Promise<SCPaginatedResponse<SCUsersInsightType>>;
|
|
7
|
+
getContributionsInsightCounters(id: number): Promise<SCContributionInsightCountersType>;
|
|
8
|
+
getEmbedsInsightCounters(id: number): Promise<SCEmbedInsightCountersType>;
|
|
9
|
+
getUsersInsightCounters(id: number): Promise<SCUsersInsightCountersType>;
|
|
8
10
|
}
|
|
11
|
+
/**
|
|
12
|
+
* Contains all the endpoints needed to manage insights.
|
|
13
|
+
*/
|
|
9
14
|
export declare class InsightApiClient {
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
static
|
|
14
|
-
|
|
15
|
-
|
|
15
|
+
/**
|
|
16
|
+
* This endpoint retrieves the best contribution insights list.
|
|
17
|
+
*/
|
|
18
|
+
static getBestContributionInsight(): Promise<SCPaginatedResponse<SCContributionInsightType>>;
|
|
19
|
+
/**
|
|
20
|
+
* This endpoint retrieves the best embed insights list. The operations of this endpoint is quite complex and returns different result structures based on the parameters passed. For example, pagination (and therefore the use of the offset parameter) is guaranteed only if the metadata and group_by parameter are not passed. If you are passing metadata you MUST pass also group_by. If you pass group_by the result will be not paginated and will contain only user defined custom embeds (not among these: 'sc_vimeo', 'sc_link', 'sc_shared_object').
|
|
21
|
+
*/
|
|
22
|
+
static getBestEmbedInsight(): Promise<SCPaginatedResponse<SCEmbedInsightType>>;
|
|
23
|
+
/**
|
|
24
|
+
* This endpoint retrieves the best users insights list.
|
|
25
|
+
*/
|
|
26
|
+
static getBestUsersInsight(): Promise<SCPaginatedResponse<SCUsersInsightType>>;
|
|
27
|
+
/**
|
|
28
|
+
* This endpoint retrieves a specific contribution's insight counters.
|
|
29
|
+
* @param id
|
|
30
|
+
*/
|
|
31
|
+
static getContributionsInsightCounters(id: number): Promise<SCContributionInsightCountersType>;
|
|
32
|
+
/**
|
|
33
|
+
* This endpoint retrieves a specific embed's insight counters.
|
|
34
|
+
* @param id
|
|
35
|
+
*/
|
|
36
|
+
static getEmbedsInsightCounters(id: number): Promise<SCEmbedInsightCountersType>;
|
|
37
|
+
/**
|
|
38
|
+
* This endpoint retrieves a specific user's insight counters.
|
|
39
|
+
* @param id
|
|
40
|
+
*/
|
|
41
|
+
static getUsersInsightCounters(id: number): Promise<SCUsersInsightCountersType>;
|
|
16
42
|
}
|
|
17
43
|
export default class InsightService {
|
|
18
|
-
static getBestContributionInsight(): Promise<
|
|
19
|
-
static getBestEmbedInsight(): Promise<
|
|
20
|
-
static getBestUsersInsight(): Promise<
|
|
21
|
-
static getContributionsInsightCounters(): Promise<
|
|
22
|
-
static getEmbedsInsightCounters(): Promise<
|
|
23
|
-
static getUsersInsightCounters(): Promise<
|
|
44
|
+
static getBestContributionInsight(): Promise<SCPaginatedResponse<SCContributionInsightType>>;
|
|
45
|
+
static getBestEmbedInsight(): Promise<SCPaginatedResponse<SCEmbedInsightType>>;
|
|
46
|
+
static getBestUsersInsight(): Promise<SCPaginatedResponse<SCUsersInsightType>>;
|
|
47
|
+
static getContributionsInsightCounters(id: number): Promise<SCContributionInsightCountersType>;
|
|
48
|
+
static getEmbedsInsightCounters(id: number): Promise<SCEmbedInsightCountersType>;
|
|
49
|
+
static getUsersInsightCounters(id: number): Promise<SCUsersInsightCountersType>;
|
|
24
50
|
}
|
|
25
51
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/services/insight/index.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/services/insight/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,mBAAmB,EAAC,MAAM,aAAa,CAAC;AAGhD,OAAO,EACL,iCAAiC,EACjC,yBAAyB,EACzB,0BAA0B,EAC1B,kBAAkB,EAClB,0BAA0B,EAC1B,kBAAkB,EACnB,MAAM,sBAAsB,CAAC;AAE9B,MAAM,WAAW,yBAAyB;IACxC,0BAA0B,IAAI,OAAO,CAAC,mBAAmB,CAAC,yBAAyB,CAAC,CAAC,CAAC;IACtF,mBAAmB,IAAI,OAAO,CAAC,mBAAmB,CAAC,kBAAkB,CAAC,CAAC,CAAC;IACxE,mBAAmB,IAAI,OAAO,CAAC,mBAAmB,CAAC,kBAAkB,CAAC,CAAC,CAAC;IACxE,+BAA+B,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,iCAAiC,CAAC,CAAC;IACxF,wBAAwB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,0BAA0B,CAAC,CAAC;IAC1E,uBAAuB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,0BAA0B,CAAC,CAAC;CAC1E;AACD;;GAEG;AAEH,qBAAa,gBAAgB;IAC3B;;OAEG;IACH,MAAM,CAAC,0BAA0B,IAAI,OAAO,CAAC,mBAAmB,CAAC,yBAAyB,CAAC,CAAC;IAI5F;;OAEG;IACH,MAAM,CAAC,mBAAmB,IAAI,OAAO,CAAC,mBAAmB,CAAC,kBAAkB,CAAC,CAAC;IAI9E;;OAEG;IACH,MAAM,CAAC,mBAAmB,IAAI,OAAO,CAAC,mBAAmB,CAAC,kBAAkB,CAAC,CAAC;IAI9E;;;OAGG;IACH,MAAM,CAAC,+BAA+B,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,iCAAiC,CAAC;IAI9F;;;OAGG;IACH,MAAM,CAAC,wBAAwB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,0BAA0B,CAAC;IAIhF;;;OAGG;IACH,MAAM,CAAC,uBAAuB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,0BAA0B,CAAC;CAGhF;AAED,MAAM,CAAC,OAAO,OAAO,cAAc;WACpB,0BAA0B,IAAI,OAAO,CAAC,mBAAmB,CAAC,yBAAyB,CAAC,CAAC;WAIrF,mBAAmB,IAAI,OAAO,CAAC,mBAAmB,CAAC,kBAAkB,CAAC,CAAC;WAIvE,mBAAmB,IAAI,OAAO,CAAC,mBAAmB,CAAC,kBAAkB,CAAC,CAAC;WAIvE,+BAA+B,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,iCAAiC,CAAC;WAIvF,wBAAwB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,0BAA0B,CAAC;WAIzE,uBAAuB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,0BAA0B,CAAC;CAGtF"}
|
|
@@ -1,25 +1,53 @@
|
|
|
1
|
+
import { LegalPageFilterParams, SCPaginatedResponse } from '../../types';
|
|
2
|
+
import { SCLegalPageAckType, SCLegalPageType } from '@selfcommunity/types';
|
|
1
3
|
export interface LegalPageApiClientInterface {
|
|
2
|
-
getLegalPages(): Promise<
|
|
3
|
-
getSpecificLegalPage(id: number): Promise<
|
|
4
|
-
searchLegalPages(): Promise<
|
|
5
|
-
ackLegalPage(id: number): Promise<
|
|
6
|
-
getSpecificUserAck(id: number): Promise<
|
|
7
|
-
userAckList(): Promise<
|
|
4
|
+
getLegalPages(params?: LegalPageFilterParams): Promise<SCPaginatedResponse<SCLegalPageType>>;
|
|
5
|
+
getSpecificLegalPage(id: number): Promise<SCLegalPageType>;
|
|
6
|
+
searchLegalPages(params?: LegalPageFilterParams): Promise<SCPaginatedResponse<SCLegalPageType>>;
|
|
7
|
+
ackLegalPage(id: number, accept?: number): Promise<SCPaginatedResponse<SCLegalPageType>>;
|
|
8
|
+
getSpecificUserAck(id: number): Promise<SCLegalPageAckType>;
|
|
9
|
+
userAckList(): Promise<SCLegalPageAckType[]>;
|
|
8
10
|
}
|
|
11
|
+
/**
|
|
12
|
+
* Contains all the endpoints needed to manage legal pages.
|
|
13
|
+
*/
|
|
9
14
|
export declare class LegalPageApiClient {
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
static
|
|
15
|
-
|
|
15
|
+
/**
|
|
16
|
+
* This endpoint retrieves all legal pages.
|
|
17
|
+
* @param params
|
|
18
|
+
*/
|
|
19
|
+
static getLegalPages(params?: LegalPageFilterParams): Promise<SCPaginatedResponse<SCLegalPageType>>;
|
|
20
|
+
/**
|
|
21
|
+
* This endpoint retrieves a specific legal page.
|
|
22
|
+
*/
|
|
23
|
+
static getSpecificLegalPage(id: number): Promise<SCLegalPageType>;
|
|
24
|
+
/**
|
|
25
|
+
* This endpoint performs search of a Legal Page.
|
|
26
|
+
* @param params
|
|
27
|
+
*/
|
|
28
|
+
static searchLegalPages(params?: LegalPageFilterParams): Promise<SCPaginatedResponse<SCLegalPageType>>;
|
|
29
|
+
/**
|
|
30
|
+
*
|
|
31
|
+
* @param id
|
|
32
|
+
* @param accept Accept or not accept a legal page, valid values are: ('true', 'on', '1').
|
|
33
|
+
*/
|
|
34
|
+
static ackLegalPage(id: number, accept?: number): Promise<SCPaginatedResponse<SCLegalPageType>>;
|
|
35
|
+
/**
|
|
36
|
+
* This endpoint retrieves a specific user ack.
|
|
37
|
+
* @param id
|
|
38
|
+
*/
|
|
39
|
+
static getSpecificUserAck(id: number): Promise<SCLegalPageAckType>;
|
|
40
|
+
/**
|
|
41
|
+
* This endpoint retrieves all user acks.
|
|
42
|
+
*/
|
|
43
|
+
static userAckList(): Promise<SCLegalPageAckType[]>;
|
|
16
44
|
}
|
|
17
45
|
export default class LegalPageService {
|
|
18
|
-
static getLegalPages(): Promise<
|
|
19
|
-
static getSpecificLegalPage(id: number): Promise<
|
|
20
|
-
static searchLegalPages(): Promise<
|
|
21
|
-
static ackLegalPage(id: number): Promise<
|
|
22
|
-
static getSpecificUserAck(id: number): Promise<
|
|
23
|
-
static userAckList(): Promise<
|
|
46
|
+
static getLegalPages(params?: LegalPageFilterParams): Promise<SCPaginatedResponse<SCLegalPageType>>;
|
|
47
|
+
static getSpecificLegalPage(id: number): Promise<SCLegalPageType>;
|
|
48
|
+
static searchLegalPages(params?: LegalPageFilterParams): Promise<SCPaginatedResponse<SCLegalPageType>>;
|
|
49
|
+
static ackLegalPage(id: number, accept?: number): Promise<SCPaginatedResponse<SCLegalPageType>>;
|
|
50
|
+
static getSpecificUserAck(id: number): Promise<SCLegalPageAckType>;
|
|
51
|
+
static userAckList(): Promise<SCLegalPageAckType[]>;
|
|
24
52
|
}
|
|
25
53
|
//# sourceMappingURL=index.d.ts.map
|