@mentio-dev/sdk 0.13.0 → 0.13.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.
Files changed (2) hide show
  1. package/dist/index.d.ts +54 -10
  2. 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 monthly mention cap, or null for none.
418
+ * The mention cap and its period, or null for none.
419
419
  */
420
420
  cap: {
421
421
  /**
422
- * Charged items allowed per calendar month (UTC): 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.
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 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.
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 calendar month (UTC): 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.
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).
@@ -4290,13 +4310,21 @@ type ListKeywordsResponses = {
4290
4310
  */
4291
4311
  pausedForCap: boolean;
4292
4312
  /**
4293
- * The monthly mention cap, or null for none.
4313
+ * The mention cap and its period, or null for none.
4294
4314
  */
4295
4315
  cap: {
4296
4316
  /**
4297
- * Charged items allowed per calendar month (UTC): 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.
4317
+ * 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
4318
  */
4299
4319
  mentions: number;
4320
+ /**
4321
+ * 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.
4322
+ */
4323
+ per?: 'day' | 'week' | 'month';
4324
+ /**
4325
+ * 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.
4326
+ */
4327
+ used: number;
4300
4328
  /**
4301
4329
  * 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
4330
  */
@@ -4305,6 +4333,14 @@ type ListKeywordsResponses = {
4305
4333
  * 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
4334
  */
4307
4335
  own: number | null;
4336
+ /**
4337
+ * The period of your own cap (null when own is null); with welcome false, the same as per.
4338
+ */
4339
+ ownPer: 'day' | 'week' | 'month';
4340
+ /**
4341
+ * While paused for its cap (pausedForCap): when its next period starts and it matches again. Null otherwise.
4342
+ */
4343
+ resumesAt: string | null;
4308
4344
  } | null;
4309
4345
  /**
4310
4346
  * 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 +4630,17 @@ type CreateKeywordData = {
4594
4630
  };
4595
4631
  };
4596
4632
  /**
4597
- * A monthly mention cap; omit or null for none.
4633
+ * A mention cap per day, week or month (per, default month); omit or null for none.
4598
4634
  */
4599
4635
  cap?: {
4600
4636
  /**
4601
- * Charged items allowed per calendar month (UTC): 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.
4637
+ * 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
4638
  */
4603
4639
  mentions: number;
4640
+ /**
4641
+ * 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.
4642
+ */
4643
+ per?: 'day' | 'week' | 'month';
4604
4644
  } | null;
4605
4645
  /**
4606
4646
  * Comments under this keyword's mentions; omitted fields are untouched (on create: off, 20 per post).
@@ -4823,13 +4863,17 @@ type UpdateKeywordData = {
4823
4863
  };
4824
4864
  };
4825
4865
  /**
4826
- * 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.
4866
+ * 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
4867
  */
4828
4868
  cap?: {
4829
4869
  /**
4830
- * Charged items allowed per calendar month (UTC): 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.
4870
+ * 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
4871
  */
4832
4872
  mentions: number;
4873
+ /**
4874
+ * 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.
4875
+ */
4876
+ per?: 'day' | 'week' | 'month';
4833
4877
  } | null;
4834
4878
  /**
4835
4879
  * Comments under this keyword's mentions; omitted fields are untouched (on create: off, 20 per post).
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@mentio-dev/sdk",
3
- "version": "0.13.0",
3
+ "version": "0.13.1",
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",