@mentio-dev/sdk 0.11.1 → 0.11.3

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.
Files changed (2) hide show
  1. package/dist/index.d.ts +30 -2
  2. package/package.json +1 -1
package/dist/index.d.ts CHANGED
@@ -454,6 +454,10 @@ type Keyword = {
454
454
  * true: the term must appear in the case it was typed (RAG, never rag). Default false.
455
455
  */
456
456
  caseSensitive: boolean;
457
+ /**
458
+ * true: only the exact phrase matches. false (default): a multi-word keyword also matches a post holding its words close together, in any order, plurals and spellings (non-profit, nonprofit) included; such a match is kept and billed only when the classifier scores it relevant. A term sent in double quotes sets this to true.
459
+ */
460
+ exactPhrase: boolean;
457
461
  };
458
462
  /**
459
463
  * Computed over this workspace's matches.
@@ -641,6 +645,10 @@ type KeywordSuggestion = {
641
645
  * true: the term must appear in the case it was typed (RAG, never rag). Default false.
642
646
  */
643
647
  caseSensitive?: boolean;
648
+ /**
649
+ * true: only the exact phrase matches. false (default): a multi-word keyword also matches a post holding its words close together, in any order, plurals and spellings (non-profit, nonprofit) included; such a match is kept and billed only when the classifier scores it relevant. A term sent in double quotes sets this to true.
650
+ */
651
+ exactPhrase?: boolean;
644
652
  };
645
653
  /**
646
654
  * Replaces the monthly mention cap; null removes it. A cap above this month's count resumes a capped keyword at once, one at or under it pauses it.
@@ -997,7 +1005,7 @@ type Mention = {
997
1005
  */
998
1006
  priority: number;
999
1007
  /**
1000
- * The keyword this post matched, and the group it is in.
1008
+ * The keyword this post matched, the group it is in, and how it matched.
1001
1009
  */
1002
1010
  keyword: {
1003
1011
  /**
@@ -1009,6 +1017,14 @@ type Mention = {
1009
1017
  */
1010
1018
  term: string;
1011
1019
  group: GroupRef;
1020
+ /**
1021
+ * phrase: the post holds the term as written. close_words: it holds the term's words close together, in another order or form (kept and billed only because the classifier scored it relevant).
1022
+ */
1023
+ matchedAs: 'phrase' | 'close_words';
1024
+ /**
1025
+ * text: the term is in the post itself (its text, caption, hashtags or review). speech: it is only in what is said in the video (TikTok), whose transcript follows the 🎙 mark in post.text.
1026
+ */
1027
+ matchedIn: 'text' | 'speech';
1012
1028
  };
1013
1029
  post: {
1014
1030
  /**
@@ -4008,6 +4024,10 @@ type ListKeywordsResponses = {
4008
4024
  * true: the term must appear in the case it was typed (RAG, never rag). Default false.
4009
4025
  */
4010
4026
  caseSensitive: boolean;
4027
+ /**
4028
+ * true: only the exact phrase matches. false (default): a multi-word keyword also matches a post holding its words close together, in any order, plurals and spellings (non-profit, nonprofit) included; such a match is kept and billed only when the classifier scores it relevant. A term sent in double quotes sets this to true.
4029
+ */
4030
+ exactPhrase: boolean;
4011
4031
  };
4012
4032
  /**
4013
4033
  * Computed over this workspace's matches.
@@ -4125,7 +4145,7 @@ type ListKeywordsResponse = ListKeywordsResponses[keyof ListKeywordsResponses];
4125
4145
  type CreateKeywordData = {
4126
4146
  body: {
4127
4147
  /**
4128
- * The word or phrase to track, matched case-insensitively as a phrase.
4148
+ * The word or phrase to track, case-insensitive. A multi-word term matches as the phrase or as its words close together (see matching.exactPhrase); wrap it in double quotes for the exact phrase only.
4129
4149
  */
4130
4150
  term: string;
4131
4151
  /**
@@ -4164,6 +4184,10 @@ type CreateKeywordData = {
4164
4184
  * true: the term must appear in the case it was typed (RAG, never rag). Default false.
4165
4185
  */
4166
4186
  caseSensitive?: boolean;
4187
+ /**
4188
+ * true: only the exact phrase matches. false (default): a multi-word keyword also matches a post holding its words close together, in any order, plurals and spellings (non-profit, nonprofit) included; such a match is kept and billed only when the classifier scores it relevant. A term sent in double quotes sets this to true.
4189
+ */
4190
+ exactPhrase?: boolean;
4167
4191
  };
4168
4192
  /**
4169
4193
  * A monthly mention cap; omit or null for none.
@@ -4333,6 +4357,10 @@ type UpdateKeywordData = {
4333
4357
  * true: the term must appear in the case it was typed (RAG, never rag). Default false.
4334
4358
  */
4335
4359
  caseSensitive?: boolean;
4360
+ /**
4361
+ * true: only the exact phrase matches. false (default): a multi-word keyword also matches a post holding its words close together, in any order, plurals and spellings (non-profit, nonprofit) included; such a match is kept and billed only when the classifier scores it relevant. A term sent in double quotes sets this to true.
4362
+ */
4363
+ exactPhrase?: boolean;
4336
4364
  };
4337
4365
  /**
4338
4366
  * Replaces the monthly mention cap; null removes it. A cap above this month's count resumes a capped keyword at once, one at or under it pauses it.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@mentio-dev/sdk",
3
- "version": "0.11.1",
3
+ "version": "0.11.3",
4
4
  "description": "TypeScript SDK for the Mentio API, generated from its OpenAPI document.",
5
5
  "license": "MIT",
6
6
  "homepage": "https://docs.mentio.dev/sdks",