@mentio-dev/sdk 0.10.0 → 0.10.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/dist/index.d.ts +27 -3
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -385,13 +385,17 @@ type Keyword = {
|
|
|
385
385
|
term: string;
|
|
386
386
|
kind: 'brand' | 'competitor' | 'topic';
|
|
387
387
|
/**
|
|
388
|
-
* Not polled or matched.
|
|
388
|
+
* Not polled or matched. Paused by you, by the wallet (see pausedForBalance) or by the noise brake (see pausedForNoise). A keyword at its mention cap is not muted (see pausedForCap).
|
|
389
389
|
*/
|
|
390
390
|
muted: boolean;
|
|
391
391
|
/**
|
|
392
392
|
* Muted by the wallet for lack of balance; a top-up resumes it, unmuting by hand needs balance too.
|
|
393
393
|
*/
|
|
394
394
|
pausedForBalance: boolean;
|
|
395
|
+
/**
|
|
396
|
+
* Muted by the noise brake: on a workspace running on its welcome credit, at least 20 of its matches were scored and under 30% were relevant. A change of its required or excluded terms, platforms or context resumes it (when the balance covers another day), and so does unmuting; a top-up does not.
|
|
397
|
+
*/
|
|
398
|
+
pausedForNoise: boolean;
|
|
395
399
|
/**
|
|
396
400
|
* At its monthly mention cap: not matched until the first of next month (UTC) or until the cap is raised. Not muted: it keeps its place and its daily keyword charge.
|
|
397
401
|
*/
|
|
@@ -404,6 +408,14 @@ type Keyword = {
|
|
|
404
408
|
* Matched mentions allowed per calendar month (UTC). Every match counts, relevant or not, the look-back a new keyword gets included, because every match bills.
|
|
405
409
|
*/
|
|
406
410
|
mentions: number;
|
|
411
|
+
/**
|
|
412
|
+
* Set by Mentio, not you: a workspace on its welcome credit collects at most 200 mentions a keyword a month. The first top-up removes it.
|
|
413
|
+
*/
|
|
414
|
+
welcome: boolean;
|
|
415
|
+
/**
|
|
416
|
+
* Your own cap. With welcome true, the cap the keyword gets back at the first top-up (null for none); otherwise the same as mentions. Sending mentions: 200 back while welcome is true changes nothing.
|
|
417
|
+
*/
|
|
418
|
+
own: number | null;
|
|
407
419
|
} | null;
|
|
408
420
|
group: GroupRef;
|
|
409
421
|
/**
|
|
@@ -2998,7 +3010,7 @@ type ListKeywordsData = {
|
|
|
2998
3010
|
/**
|
|
2999
3011
|
* Only keywords in these states: active, muted, paused, capped. Repeatable, or comma-separated.
|
|
3000
3012
|
*/
|
|
3001
|
-
status?: Array<'active' | 'muted' | 'paused' | 'capped'>;
|
|
3013
|
+
status?: Array<'active' | 'muted' | 'paused' | 'noisy' | 'capped'>;
|
|
3002
3014
|
/**
|
|
3003
3015
|
* Only keywords tracked on any of these platforms: its term searched there (every platform when its platforms are null), or for appstore and googleplay, an app of that store among its reviewSources. Repeatable, or comma-separated.
|
|
3004
3016
|
*/
|
|
@@ -3042,13 +3054,17 @@ type ListKeywordsResponses = {
|
|
|
3042
3054
|
term: string;
|
|
3043
3055
|
kind: 'brand' | 'competitor' | 'topic';
|
|
3044
3056
|
/**
|
|
3045
|
-
* Not polled or matched.
|
|
3057
|
+
* Not polled or matched. Paused by you, by the wallet (see pausedForBalance) or by the noise brake (see pausedForNoise). A keyword at its mention cap is not muted (see pausedForCap).
|
|
3046
3058
|
*/
|
|
3047
3059
|
muted: boolean;
|
|
3048
3060
|
/**
|
|
3049
3061
|
* Muted by the wallet for lack of balance; a top-up resumes it, unmuting by hand needs balance too.
|
|
3050
3062
|
*/
|
|
3051
3063
|
pausedForBalance: boolean;
|
|
3064
|
+
/**
|
|
3065
|
+
* Muted by the noise brake: on a workspace running on its welcome credit, at least 20 of its matches were scored and under 30% were relevant. A change of its required or excluded terms, platforms or context resumes it (when the balance covers another day), and so does unmuting; a top-up does not.
|
|
3066
|
+
*/
|
|
3067
|
+
pausedForNoise: boolean;
|
|
3052
3068
|
/**
|
|
3053
3069
|
* At its monthly mention cap: not matched until the first of next month (UTC) or until the cap is raised. Not muted: it keeps its place and its daily keyword charge.
|
|
3054
3070
|
*/
|
|
@@ -3061,6 +3077,14 @@ type ListKeywordsResponses = {
|
|
|
3061
3077
|
* Matched mentions allowed per calendar month (UTC). Every match counts, relevant or not, the look-back a new keyword gets included, because every match bills.
|
|
3062
3078
|
*/
|
|
3063
3079
|
mentions: number;
|
|
3080
|
+
/**
|
|
3081
|
+
* Set by Mentio, not you: a workspace on its welcome credit collects at most 200 mentions a keyword a month. The first top-up removes it.
|
|
3082
|
+
*/
|
|
3083
|
+
welcome: boolean;
|
|
3084
|
+
/**
|
|
3085
|
+
* Your own cap. With welcome true, the cap the keyword gets back at the first top-up (null for none); otherwise the same as mentions. Sending mentions: 200 back while welcome is true changes nothing.
|
|
3086
|
+
*/
|
|
3087
|
+
own: number | null;
|
|
3064
3088
|
} | null;
|
|
3065
3089
|
group: GroupRef;
|
|
3066
3090
|
/**
|