@mentio-dev/sdk 0.13.0 → 0.13.2
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 +62 -10
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -415,13 +415,21 @@ type Keyword = {
|
|
|
415
415
|
*/
|
|
416
416
|
pausedForCap: boolean;
|
|
417
417
|
/**
|
|
418
|
-
* The
|
|
418
|
+
* The mention cap and its period, or null for none.
|
|
419
419
|
*/
|
|
420
420
|
cap: {
|
|
421
421
|
/**
|
|
422
|
-
* Charged items allowed per
|
|
422
|
+
* Charged items allowed per period (see per): matched mentions plus the thread comments delivered under them. Every match counts, relevant or not, the look-back a new keyword gets included, because every match bills.
|
|
423
423
|
*/
|
|
424
424
|
mentions: number;
|
|
425
|
+
/**
|
|
426
|
+
* The period the cap counts in, in UTC: day (from 00:00), week (from Monday 00:00) or month (the calendar month, the default). At the cap the keyword stops until the next period starts, so a daily cap keeps mentions coming every day with a fixed ceiling on spend.
|
|
427
|
+
*/
|
|
428
|
+
per?: 'day' | 'week' | 'month';
|
|
429
|
+
/**
|
|
430
|
+
* Charged items (matches plus thread comments) counted in the current period: today, this week from Monday or this month, UTC. The keyword pauses when it reaches mentions.
|
|
431
|
+
*/
|
|
432
|
+
used: number;
|
|
425
433
|
/**
|
|
426
434
|
* 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.
|
|
427
435
|
*/
|
|
@@ -430,6 +438,14 @@ type Keyword = {
|
|
|
430
438
|
* 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.
|
|
431
439
|
*/
|
|
432
440
|
own: number | null;
|
|
441
|
+
/**
|
|
442
|
+
* The period of your own cap (null when own is null); with welcome false, the same as per.
|
|
443
|
+
*/
|
|
444
|
+
ownPer: 'day' | 'week' | 'month';
|
|
445
|
+
/**
|
|
446
|
+
* While paused for its cap (pausedForCap): when its next period starts and it matches again. Null otherwise.
|
|
447
|
+
*/
|
|
448
|
+
resumesAt: string | null;
|
|
433
449
|
} | null;
|
|
434
450
|
/**
|
|
435
451
|
* Comments under this keyword's mentions: when enabled, the comments of every mention scored relevant are read from 30 minutes after the post, on a schedule per platform (for a day on Reddit, Hacker News and Bluesky, a week on GitHub, Stack Overflow and DEV, a month on YouTube) (new comments only, at most maxPerPost a thread, comments of fewer than three words dropped), on Hacker News, Bluesky, GitHub, Stack Overflow, DEV, YouTube and Reddit. List them with GET /v1/mentions/{id}/comments.
|
|
@@ -754,13 +770,17 @@ type KeywordSuggestion = {
|
|
|
754
770
|
};
|
|
755
771
|
};
|
|
756
772
|
/**
|
|
757
|
-
* Replaces the
|
|
773
|
+
* Replaces the mention cap and its period (per, default month); null removes it. A cap above the current period's count resumes a capped keyword at once, one at or under it pauses it.
|
|
758
774
|
*/
|
|
759
775
|
cap?: {
|
|
760
776
|
/**
|
|
761
|
-
* Charged items allowed per
|
|
777
|
+
* Charged items allowed per period (see per): matched mentions plus the thread comments delivered under them. Every match counts, relevant or not, the look-back a new keyword gets included, because every match bills.
|
|
762
778
|
*/
|
|
763
779
|
mentions: number;
|
|
780
|
+
/**
|
|
781
|
+
* The period the cap counts in, in UTC: day (from 00:00), week (from Monday 00:00) or month (the calendar month, the default). At the cap the keyword stops until the next period starts, so a daily cap keeps mentions coming every day with a fixed ceiling on spend.
|
|
782
|
+
*/
|
|
783
|
+
per?: 'day' | 'week' | 'month';
|
|
764
784
|
} | null;
|
|
765
785
|
/**
|
|
766
786
|
* Comments under this keyword's mentions; omitted fields are untouched (on create: off, 20 per post).
|
|
@@ -2961,6 +2981,14 @@ type Wallet = {
|
|
|
2961
2981
|
* How much to add per automatic charge (same bounds as a manual top-up).
|
|
2962
2982
|
*/
|
|
2963
2983
|
amountCents: number;
|
|
2984
|
+
/**
|
|
2985
|
+
* Most the saved card may be charged automatically over any 7 days, before tax; null = no limit.
|
|
2986
|
+
*/
|
|
2987
|
+
weeklyLimitCents: number | null;
|
|
2988
|
+
/**
|
|
2989
|
+
* What counts against the weekly limit over the last 7 days, before tax: automatic charges made plus any still settling.
|
|
2990
|
+
*/
|
|
2991
|
+
spentThisWeekCents: number;
|
|
2964
2992
|
/**
|
|
2965
2993
|
* Newest successful automatic charge.
|
|
2966
2994
|
*/
|
|
@@ -4290,13 +4318,21 @@ type ListKeywordsResponses = {
|
|
|
4290
4318
|
*/
|
|
4291
4319
|
pausedForCap: boolean;
|
|
4292
4320
|
/**
|
|
4293
|
-
* The
|
|
4321
|
+
* The mention cap and its period, or null for none.
|
|
4294
4322
|
*/
|
|
4295
4323
|
cap: {
|
|
4296
4324
|
/**
|
|
4297
|
-
* Charged items allowed per
|
|
4325
|
+
* Charged items allowed per period (see per): matched mentions plus the thread comments delivered under them. Every match counts, relevant or not, the look-back a new keyword gets included, because every match bills.
|
|
4298
4326
|
*/
|
|
4299
4327
|
mentions: number;
|
|
4328
|
+
/**
|
|
4329
|
+
* The period the cap counts in, in UTC: day (from 00:00), week (from Monday 00:00) or month (the calendar month, the default). At the cap the keyword stops until the next period starts, so a daily cap keeps mentions coming every day with a fixed ceiling on spend.
|
|
4330
|
+
*/
|
|
4331
|
+
per?: 'day' | 'week' | 'month';
|
|
4332
|
+
/**
|
|
4333
|
+
* Charged items (matches plus thread comments) counted in the current period: today, this week from Monday or this month, UTC. The keyword pauses when it reaches mentions.
|
|
4334
|
+
*/
|
|
4335
|
+
used: number;
|
|
4300
4336
|
/**
|
|
4301
4337
|
* 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.
|
|
4302
4338
|
*/
|
|
@@ -4305,6 +4341,14 @@ type ListKeywordsResponses = {
|
|
|
4305
4341
|
* 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.
|
|
4306
4342
|
*/
|
|
4307
4343
|
own: number | null;
|
|
4344
|
+
/**
|
|
4345
|
+
* The period of your own cap (null when own is null); with welcome false, the same as per.
|
|
4346
|
+
*/
|
|
4347
|
+
ownPer: 'day' | 'week' | 'month';
|
|
4348
|
+
/**
|
|
4349
|
+
* While paused for its cap (pausedForCap): when its next period starts and it matches again. Null otherwise.
|
|
4350
|
+
*/
|
|
4351
|
+
resumesAt: string | null;
|
|
4308
4352
|
} | null;
|
|
4309
4353
|
/**
|
|
4310
4354
|
* Comments under this keyword's mentions: when enabled, the comments of every mention scored relevant are read from 30 minutes after the post, on a schedule per platform (for a day on Reddit, Hacker News and Bluesky, a week on GitHub, Stack Overflow and DEV, a month on YouTube) (new comments only, at most maxPerPost a thread, comments of fewer than three words dropped), on Hacker News, Bluesky, GitHub, Stack Overflow, DEV, YouTube and Reddit. List them with GET /v1/mentions/{id}/comments.
|
|
@@ -4594,13 +4638,17 @@ type CreateKeywordData = {
|
|
|
4594
4638
|
};
|
|
4595
4639
|
};
|
|
4596
4640
|
/**
|
|
4597
|
-
* A
|
|
4641
|
+
* A mention cap per day, week or month (per, default month); omit or null for none.
|
|
4598
4642
|
*/
|
|
4599
4643
|
cap?: {
|
|
4600
4644
|
/**
|
|
4601
|
-
* Charged items allowed per
|
|
4645
|
+
* Charged items allowed per period (see per): matched mentions plus the thread comments delivered under them. Every match counts, relevant or not, the look-back a new keyword gets included, because every match bills.
|
|
4602
4646
|
*/
|
|
4603
4647
|
mentions: number;
|
|
4648
|
+
/**
|
|
4649
|
+
* The period the cap counts in, in UTC: day (from 00:00), week (from Monday 00:00) or month (the calendar month, the default). At the cap the keyword stops until the next period starts, so a daily cap keeps mentions coming every day with a fixed ceiling on spend.
|
|
4650
|
+
*/
|
|
4651
|
+
per?: 'day' | 'week' | 'month';
|
|
4604
4652
|
} | null;
|
|
4605
4653
|
/**
|
|
4606
4654
|
* Comments under this keyword's mentions; omitted fields are untouched (on create: off, 20 per post).
|
|
@@ -4823,13 +4871,17 @@ type UpdateKeywordData = {
|
|
|
4823
4871
|
};
|
|
4824
4872
|
};
|
|
4825
4873
|
/**
|
|
4826
|
-
* Replaces the
|
|
4874
|
+
* Replaces the mention cap and its period (per, default month); null removes it. A cap above the current period's count resumes a capped keyword at once, one at or under it pauses it.
|
|
4827
4875
|
*/
|
|
4828
4876
|
cap?: {
|
|
4829
4877
|
/**
|
|
4830
|
-
* Charged items allowed per
|
|
4878
|
+
* Charged items allowed per period (see per): matched mentions plus the thread comments delivered under them. Every match counts, relevant or not, the look-back a new keyword gets included, because every match bills.
|
|
4831
4879
|
*/
|
|
4832
4880
|
mentions: number;
|
|
4881
|
+
/**
|
|
4882
|
+
* The period the cap counts in, in UTC: day (from 00:00), week (from Monday 00:00) or month (the calendar month, the default). At the cap the keyword stops until the next period starts, so a daily cap keeps mentions coming every day with a fixed ceiling on spend.
|
|
4883
|
+
*/
|
|
4884
|
+
per?: 'day' | 'week' | 'month';
|
|
4833
4885
|
} | null;
|
|
4834
4886
|
/**
|
|
4835
4887
|
* Comments under this keyword's mentions; omitted fields are untouched (on create: off, 20 per post).
|