@selfcommunity/api-services 0.4.21 → 0.4.22-alpha.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -20,7 +20,7 @@ export declare class InsightApiClient {
20
20
  */
21
21
  static getBestContributionInsight(params?: InsightContributionParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCContributionInsightType>>;
22
22
  /**
23
- * 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').
23
+ * 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_link', 'sc_shared_object').
24
24
  * @param params
25
25
  * @param config
26
26
  */
@@ -19,7 +19,7 @@ class InsightApiClient {
19
19
  return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: `${Endpoints_1.default.InsightBestContribution.url({})}?${p.toString()}`, method: Endpoints_1.default.InsightBestContribution.method }));
20
20
  }
21
21
  /**
22
- * 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').
22
+ * 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_link', 'sc_shared_object').
23
23
  * @param params
24
24
  * @param config
25
25
  */
@@ -9,7 +9,7 @@ export interface EmbedUpdateParams {
9
9
  url?: string | null;
10
10
  /**
11
11
  * Metadata associated to this embed. It mus be a valid json object.
12
- * For embed_type sc_vimeo or sc_link it contains metadata associated
12
+ * For embed_type sc_link it contains metadata associated
13
13
  * with the external resource. For embed_type sc_shared_object it contains a field
14
14
  * type that is the type of the object (Discussion or Post) and a field id
15
15
  * that contains the id of the object shared
@@ -20,7 +20,7 @@ export declare class InsightApiClient {
20
20
  */
21
21
  static getBestContributionInsight(params?: InsightContributionParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCContributionInsightType>>;
22
22
  /**
23
- * 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').
23
+ * 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_link', 'sc_shared_object').
24
24
  * @param params
25
25
  * @param config
26
26
  */
@@ -16,7 +16,7 @@ export class InsightApiClient {
16
16
  return apiRequest(Object.assign(Object.assign({}, config), { url: `${Endpoints.InsightBestContribution.url({})}?${p.toString()}`, method: Endpoints.InsightBestContribution.method }));
17
17
  }
18
18
  /**
19
- * 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').
19
+ * 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_link', 'sc_shared_object').
20
20
  * @param params
21
21
  * @param config
22
22
  */
@@ -9,7 +9,7 @@ export interface EmbedUpdateParams {
9
9
  url?: string | null;
10
10
  /**
11
11
  * Metadata associated to this embed. It mus be a valid json object.
12
- * For embed_type sc_vimeo or sc_link it contains metadata associated
12
+ * For embed_type sc_link it contains metadata associated
13
13
  * with the external resource. For embed_type sc_shared_object it contains a field
14
14
  * type that is the type of the object (Discussion or Post) and a field id
15
15
  * that contains the id of the object shared
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@selfcommunity/api-services",
3
- "version": "0.4.21",
3
+ "version": "0.4.22-alpha.0",
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.21",
62
- "@selfcommunity/utils": "^0.2.21",
61
+ "@selfcommunity/types": "^0.5.22-alpha.0",
62
+ "@selfcommunity/utils": "^0.2.22-alpha.0",
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": "9403928404224980f88d5a5438f5072da0a7fee9"
113
+ "gitHead": "c53f28fd76cccd295be658c79e04392cc59da0af"
114
114
  }