@selfcommunity/api-services 0.4.9-alpha.17 → 0.4.9-alpha.19

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.
@@ -29,7 +29,7 @@ export declare class LegalPageApiClient {
29
29
  static getSpecificLegalPage(id: number | string, config?: AxiosRequestConfig): Promise<SCLegalPageType>;
30
30
  /**
31
31
  * This endpoint retrieves all revisions of a legal page.
32
- * @param id
32
+ * @param policy
33
33
  * @param config
34
34
  */
35
35
  static getAllRevisionsOfLegalPage(policy: string, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCLegalPageType>>;
@@ -39,7 +39,7 @@ export declare class LegalPageApiClient {
39
39
  static getAllLastRevisionsOfLegalPages(config?: AxiosRequestConfig): Promise<SCLegalPageType[]>;
40
40
  /**
41
41
  * This endpoint retrieves last revision of a legal page.
42
- * @param id
42
+ * @param policy
43
43
  * @param config
44
44
  */
45
45
  static getLastRevisionOfLegalPage(policy: string, config?: AxiosRequestConfig): Promise<SCLegalPageType>;
@@ -28,7 +28,7 @@ class LegalPageApiClient {
28
28
  }
29
29
  /**
30
30
  * This endpoint retrieves all revisions of a legal page.
31
- * @param id
31
+ * @param policy
32
32
  * @param config
33
33
  */
34
34
  static getAllRevisionsOfLegalPage(policy, config) {
@@ -42,7 +42,7 @@ class LegalPageApiClient {
42
42
  }
43
43
  /**
44
44
  * This endpoint retrieves last revision of a legal page.
45
- * @param id
45
+ * @param policy
46
46
  * @param config
47
47
  */
48
48
  static getLastRevisionOfLegalPage(policy, config) {
@@ -129,6 +129,7 @@ export declare class UserApiClient {
129
129
  * @param id
130
130
  * @param new_email
131
131
  * @param confirm
132
+ * @param send_email
132
133
  * @param config
133
134
  */
134
135
  static changeUserMail(id: number | string, new_email: string, confirm?: boolean, send_email?: boolean, config?: AxiosRequestConfig): Promise<any | SCUserChangeEmailType>;
@@ -192,20 +193,21 @@ export declare class UserApiClient {
192
193
  /**
193
194
  * This endpoint retrieves the list of posts of the user identified by ID.
194
195
  * @param id
196
+ * @param params
195
197
  * @param config
196
198
  */
197
199
  static getUserFeed(id: number | string, params?: BaseGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCFeedUnitType>>;
198
200
  /**
199
201
  * This endpoint retrieves the list of followers of a specific user identified by ID.
200
202
  * @param id
201
- * @param mutual
203
+ * @param params
202
204
  * @param config
203
205
  */
204
206
  static getUserFollowers(id: number | string, params?: UserGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCUserType>>;
205
207
  /**
206
- * This endpoint retrieves the list of following of a specific user identified by ID..
208
+ * This endpoint retrieves the list of following of a specific user identified by ID.
207
209
  * @param id
208
- * @param mutual
210
+ * @param params
209
211
  * @param config
210
212
  */
211
213
  static getUserFollowings(id: number | string, params?: UserGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCUserType>>;
@@ -230,7 +232,7 @@ export declare class UserApiClient {
230
232
  /**
231
233
  * This endpoint retrieves the list of connections of a specific user identified by ID.
232
234
  * @param id
233
- * @param mutual
235
+ * @param params
234
236
  * @param config
235
237
  */
236
238
  static getUserConnections(id: number | string, params?: UserGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCUserType>>;
@@ -242,13 +244,13 @@ export declare class UserApiClient {
242
244
  static checkUserConnections(id: number | string, config?: AxiosRequestConfig): Promise<SCUserConnectionStatusType>;
243
245
  /**
244
246
  * This endpoint retrieves the list of connection requests received by a specific user identified by ID.
245
- * @param id
247
+ * @param params
246
248
  * @param config
247
249
  */
248
250
  static getUserConnectionRequests(params?: BaseGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCUserConnectionRequestType>>;
249
251
  /**
250
252
  * This endpoint retrieves a specific user's list of connection requests sent by user.
251
- * @param id
253
+ * @param params
252
254
  * @param config
253
255
  */
254
256
  static getUserRequestConnectionsSent(params?: BaseGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCUserConnectionRequestType>>;
@@ -105,6 +105,7 @@ class UserApiClient {
105
105
  * @param id
106
106
  * @param new_email
107
107
  * @param confirm
108
+ * @param send_email
108
109
  * @param config
109
110
  */
110
111
  static changeUserMail(id, new_email, confirm, send_email, config) {
@@ -196,6 +197,7 @@ class UserApiClient {
196
197
  /**
197
198
  * This endpoint retrieves the list of posts of the user identified by ID.
198
199
  * @param id
200
+ * @param params
199
201
  * @param config
200
202
  */
201
203
  static getUserFeed(id, params, config) {
@@ -204,16 +206,16 @@ class UserApiClient {
204
206
  /**
205
207
  * This endpoint retrieves the list of followers of a specific user identified by ID.
206
208
  * @param id
207
- * @param mutual
209
+ * @param params
208
210
  * @param config
209
211
  */
210
212
  static getUserFollowers(id, params, config) {
211
213
  return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.UserFollowers.url({ id }), method: Endpoints_1.default.UserFollowers.method, params }));
212
214
  }
213
215
  /**
214
- * This endpoint retrieves the list of following of a specific user identified by ID..
216
+ * This endpoint retrieves the list of following of a specific user identified by ID.
215
217
  * @param id
216
- * @param mutual
218
+ * @param params
217
219
  * @param config
218
220
  */
219
221
  static getUserFollowings(id, params, config) {
@@ -246,7 +248,7 @@ class UserApiClient {
246
248
  /**
247
249
  * This endpoint retrieves the list of connections of a specific user identified by ID.
248
250
  * @param id
249
- * @param mutual
251
+ * @param params
250
252
  * @param config
251
253
  */
252
254
  static getUserConnections(id, params, config) {
@@ -262,7 +264,7 @@ class UserApiClient {
262
264
  }
263
265
  /**
264
266
  * This endpoint retrieves the list of connection requests received by a specific user identified by ID.
265
- * @param id
267
+ * @param params
266
268
  * @param config
267
269
  */
268
270
  static getUserConnectionRequests(params, config) {
@@ -270,7 +272,7 @@ class UserApiClient {
270
272
  }
271
273
  /**
272
274
  * This endpoint retrieves a specific user's list of connection requests sent by user.
273
- * @param id
275
+ * @param params
274
276
  * @param config
275
277
  */
276
278
  static getUserRequestConnectionsSent(params, config) {
@@ -29,7 +29,7 @@ export declare class LegalPageApiClient {
29
29
  static getSpecificLegalPage(id: number | string, config?: AxiosRequestConfig): Promise<SCLegalPageType>;
30
30
  /**
31
31
  * This endpoint retrieves all revisions of a legal page.
32
- * @param id
32
+ * @param policy
33
33
  * @param config
34
34
  */
35
35
  static getAllRevisionsOfLegalPage(policy: string, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCLegalPageType>>;
@@ -39,7 +39,7 @@ export declare class LegalPageApiClient {
39
39
  static getAllLastRevisionsOfLegalPages(config?: AxiosRequestConfig): Promise<SCLegalPageType[]>;
40
40
  /**
41
41
  * This endpoint retrieves last revision of a legal page.
42
- * @param id
42
+ * @param policy
43
43
  * @param config
44
44
  */
45
45
  static getLastRevisionOfLegalPage(policy: string, config?: AxiosRequestConfig): Promise<SCLegalPageType>;
@@ -25,7 +25,7 @@ export class LegalPageApiClient {
25
25
  }
26
26
  /**
27
27
  * This endpoint retrieves all revisions of a legal page.
28
- * @param id
28
+ * @param policy
29
29
  * @param config
30
30
  */
31
31
  static getAllRevisionsOfLegalPage(policy, config) {
@@ -39,7 +39,7 @@ export class LegalPageApiClient {
39
39
  }
40
40
  /**
41
41
  * This endpoint retrieves last revision of a legal page.
42
- * @param id
42
+ * @param policy
43
43
  * @param config
44
44
  */
45
45
  static getLastRevisionOfLegalPage(policy, config) {
@@ -129,6 +129,7 @@ export declare class UserApiClient {
129
129
  * @param id
130
130
  * @param new_email
131
131
  * @param confirm
132
+ * @param send_email
132
133
  * @param config
133
134
  */
134
135
  static changeUserMail(id: number | string, new_email: string, confirm?: boolean, send_email?: boolean, config?: AxiosRequestConfig): Promise<any | SCUserChangeEmailType>;
@@ -192,20 +193,21 @@ export declare class UserApiClient {
192
193
  /**
193
194
  * This endpoint retrieves the list of posts of the user identified by ID.
194
195
  * @param id
196
+ * @param params
195
197
  * @param config
196
198
  */
197
199
  static getUserFeed(id: number | string, params?: BaseGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCFeedUnitType>>;
198
200
  /**
199
201
  * This endpoint retrieves the list of followers of a specific user identified by ID.
200
202
  * @param id
201
- * @param mutual
203
+ * @param params
202
204
  * @param config
203
205
  */
204
206
  static getUserFollowers(id: number | string, params?: UserGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCUserType>>;
205
207
  /**
206
- * This endpoint retrieves the list of following of a specific user identified by ID..
208
+ * This endpoint retrieves the list of following of a specific user identified by ID.
207
209
  * @param id
208
- * @param mutual
210
+ * @param params
209
211
  * @param config
210
212
  */
211
213
  static getUserFollowings(id: number | string, params?: UserGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCUserType>>;
@@ -230,7 +232,7 @@ export declare class UserApiClient {
230
232
  /**
231
233
  * This endpoint retrieves the list of connections of a specific user identified by ID.
232
234
  * @param id
233
- * @param mutual
235
+ * @param params
234
236
  * @param config
235
237
  */
236
238
  static getUserConnections(id: number | string, params?: UserGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCUserType>>;
@@ -242,13 +244,13 @@ export declare class UserApiClient {
242
244
  static checkUserConnections(id: number | string, config?: AxiosRequestConfig): Promise<SCUserConnectionStatusType>;
243
245
  /**
244
246
  * This endpoint retrieves the list of connection requests received by a specific user identified by ID.
245
- * @param id
247
+ * @param params
246
248
  * @param config
247
249
  */
248
250
  static getUserConnectionRequests(params?: BaseGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCUserConnectionRequestType>>;
249
251
  /**
250
252
  * This endpoint retrieves a specific user's list of connection requests sent by user.
251
- * @param id
253
+ * @param params
252
254
  * @param config
253
255
  */
254
256
  static getUserRequestConnectionsSent(params?: BaseGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCUserConnectionRequestType>>;
@@ -102,6 +102,7 @@ export class UserApiClient {
102
102
  * @param id
103
103
  * @param new_email
104
104
  * @param confirm
105
+ * @param send_email
105
106
  * @param config
106
107
  */
107
108
  static changeUserMail(id, new_email, confirm, send_email, config) {
@@ -193,6 +194,7 @@ export class UserApiClient {
193
194
  /**
194
195
  * This endpoint retrieves the list of posts of the user identified by ID.
195
196
  * @param id
197
+ * @param params
196
198
  * @param config
197
199
  */
198
200
  static getUserFeed(id, params, config) {
@@ -201,16 +203,16 @@ export class UserApiClient {
201
203
  /**
202
204
  * This endpoint retrieves the list of followers of a specific user identified by ID.
203
205
  * @param id
204
- * @param mutual
206
+ * @param params
205
207
  * @param config
206
208
  */
207
209
  static getUserFollowers(id, params, config) {
208
210
  return apiRequest(Object.assign(Object.assign({}, config), { url: Endpoints.UserFollowers.url({ id }), method: Endpoints.UserFollowers.method, params }));
209
211
  }
210
212
  /**
211
- * This endpoint retrieves the list of following of a specific user identified by ID..
213
+ * This endpoint retrieves the list of following of a specific user identified by ID.
212
214
  * @param id
213
- * @param mutual
215
+ * @param params
214
216
  * @param config
215
217
  */
216
218
  static getUserFollowings(id, params, config) {
@@ -243,7 +245,7 @@ export class UserApiClient {
243
245
  /**
244
246
  * This endpoint retrieves the list of connections of a specific user identified by ID.
245
247
  * @param id
246
- * @param mutual
248
+ * @param params
247
249
  * @param config
248
250
  */
249
251
  static getUserConnections(id, params, config) {
@@ -259,7 +261,7 @@ export class UserApiClient {
259
261
  }
260
262
  /**
261
263
  * This endpoint retrieves the list of connection requests received by a specific user identified by ID.
262
- * @param id
264
+ * @param params
263
265
  * @param config
264
266
  */
265
267
  static getUserConnectionRequests(params, config) {
@@ -267,7 +269,7 @@ export class UserApiClient {
267
269
  }
268
270
  /**
269
271
  * This endpoint retrieves a specific user's list of connection requests sent by user.
270
- * @param id
272
+ * @param params
271
273
  * @param config
272
274
  */
273
275
  static getUserRequestConnectionsSent(params, config) {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@selfcommunity/api-services",
3
- "version": "0.4.9-alpha.17",
3
+ "version": "0.4.9-alpha.19",
4
4
  "license": "MIT",
5
5
  "private": false,
6
6
  "main": "./lib/cjs/index.js",
@@ -58,8 +58,8 @@
58
58
  "access": "public"
59
59
  },
60
60
  "dependencies": {
61
- "@selfcommunity/types": "^0.5.9-alpha.11",
62
- "@selfcommunity/utils": "^0.2.9-alpha.0",
61
+ "@selfcommunity/types": "^0.5.9-alpha.12",
62
+ "@selfcommunity/utils": "^0.2.9-alpha.1",
63
63
  "axios": "^1.4.0",
64
64
  "jose": "^4.14.4"
65
65
  },
@@ -110,5 +110,5 @@
110
110
  "bugs": {
111
111
  "url": "https://github.com/selfcommunity/community-js/issues"
112
112
  },
113
- "gitHead": "5c5901ad7f1acbc64e78b685188c097ccfae280a"
113
+ "gitHead": "0098b014f6c947da317ff96fb0809ad65edff179"
114
114
  }