@remit/api-openapi-types 0.0.103 → 0.0.104

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/package.json +1 -1
  2. package/types.d.ts +41 -9
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@remit/api-openapi-types",
3
- "version": "0.0.103",
3
+ "version": "0.0.104",
4
4
  "type": "module",
5
5
  "main": "types.d.ts",
6
6
  "types": "types.d.ts",
package/types.d.ts CHANGED
@@ -165,6 +165,10 @@ current enum emitter anyway, so the wire contract uses the bare form.
165
165
  * The part of the From address a FilterRule address test reads (RFC 040). `RegistrableDomain` is the public-suffix aware domain.
166
166
  */
167
167
  export type FilterRuleAddressPart = "All" | "Localpart" | "Domain" | "RegistrableDomain";
168
+ /**
169
+ * A label a classification provider picks for a message: the junk verdicts, priority, and the message categories.
170
+ */
171
+ export type ClassificationLabel = "Spam" | "Phishing" | "Priority" | "Personal" | "Newsletter" | "Marketing" | "Automated" | "Transactional" | "Social" | "ColdOutreach";
168
172
  /**
169
173
  * Display color for a user-defined Label (RFC 030).
170
174
  */
@@ -245,10 +249,6 @@ current enum emitter anyway, so the wire contract uses the bare form.
245
249
  * Why a classification provider cannot run.
246
250
  */
247
251
  export type ClassificationUnrunnableReason = "NoBaseUrl" | "NoApiKey";
248
- /**
249
- * A label a classification provider picks for a message: the junk verdicts, priority, and the message categories.
250
- */
251
- export type ClassificationLabel = "Spam" | "Phishing" | "Priority" | "Personal" | "Newsletter" | "Marketing" | "Automated" | "Transactional" | "Social" | "ColdOutreach";
252
252
  /**
253
253
  * Why a classification provider call gave no usable answer.
254
254
  */
@@ -2444,28 +2444,28 @@ create one (RFC 034 recap).
2444
2444
  */
2445
2445
  export interface FilterRuleV1 {
2446
2446
  version: 1;
2447
- test: FilterAllOfTest | FilterAnyOfTest | FilterNotTest | FilterHeaderTest | FilterAddressTest | FilterHasWordsTest;
2447
+ test: FilterAllOfTest | FilterAnyOfTest | FilterNotTest | FilterHeaderTest | FilterAddressTest | FilterHasWordsTest | FilterClassificationTest;
2448
2448
  }
2449
2449
  /**
2450
2450
  * Matches when every test in `tests` matches (Sieve `allof`).
2451
2451
  */
2452
2452
  export interface FilterAllOfTest {
2453
2453
  test: "allof";
2454
- tests: (FilterAllOfTest | FilterAnyOfTest | FilterNotTest | FilterHeaderTest | FilterAddressTest | FilterHasWordsTest)[];
2454
+ tests: (FilterAllOfTest | FilterAnyOfTest | FilterNotTest | FilterHeaderTest | FilterAddressTest | FilterHasWordsTest | FilterClassificationTest)[];
2455
2455
  }
2456
2456
  /**
2457
2457
  * Matches when any test in `tests` matches (Sieve `anyof`).
2458
2458
  */
2459
2459
  export interface FilterAnyOfTest {
2460
2460
  test: "anyof";
2461
- tests: (FilterAllOfTest | FilterAnyOfTest | FilterNotTest | FilterHeaderTest | FilterAddressTest | FilterHasWordsTest)[];
2461
+ tests: (FilterAllOfTest | FilterAnyOfTest | FilterNotTest | FilterHeaderTest | FilterAddressTest | FilterHasWordsTest | FilterClassificationTest)[];
2462
2462
  }
2463
2463
  /**
2464
2464
  * Matches when `operand` does not (Sieve `not`).
2465
2465
  */
2466
2466
  export interface FilterNotTest {
2467
2467
  test: "not";
2468
- operand: FilterAllOfTest | FilterAnyOfTest | FilterNotTest | FilterHeaderTest | FilterAddressTest | FilterHasWordsTest;
2468
+ operand: FilterAllOfTest | FilterAnyOfTest | FilterNotTest | FilterHeaderTest | FilterAddressTest | FilterHasWordsTest | FilterClassificationTest;
2469
2469
  }
2470
2470
  /**
2471
2471
  * Compares one header against one key (Sieve `header`).
@@ -2492,6 +2492,13 @@ create one (RFC 034 recap).
2492
2492
  test: "hasWords";
2493
2493
  words: String256[];
2494
2494
  }
2495
+ /**
2496
+ * Matches when the classifier gave the message a confident score for `label`. A message with no scores fails it.
2497
+ */
2498
+ export interface FilterClassificationTest {
2499
+ test: "classification";
2500
+ label: ClassificationLabel;
2501
+ }
2495
2502
  /**
2496
2503
  * Filter item returned by list/get/create/update operations. `ttl` is internal bookkeeping (RFC 034 Decision 1.3) and not surfaced.
2497
2504
  */
@@ -7549,6 +7556,29 @@ single `get` checks whether it is already set.
7549
7556
  createdAt: number;
7550
7557
  updatedAt: number;
7551
7558
  }
7559
+ /**
7560
+ * The folder a label maps to in one account, keyed by labelId + accountId (RFC 040).
7561
+ */
7562
+ export interface LabelMailbox {
7563
+ /**
7564
+ * Deterministic id derived from labelId + accountId
7565
+ */
7566
+ labelMailboxId: UUID;
7567
+ /**
7568
+ * Label the folder belongs to
7569
+ */
7570
+ labelId: UUID;
7571
+ /**
7572
+ * Account that owns the folder
7573
+ */
7574
+ accountId: UUID;
7575
+ /**
7576
+ * The label's folder in that account
7577
+ */
7578
+ mailboxId: UUID;
7579
+ createdAt: number;
7580
+ updatedAt: number;
7581
+ }
7552
7582
  export interface MicrosoftOAuthStartRequest {
7553
7583
  /**
7554
7584
  * Optional email hint for the Microsoft login page
@@ -11547,6 +11577,7 @@ export type FilterNotTest = Components.Schemas.FilterNotTest;
11547
11577
  export type FilterHeaderTest = Components.Schemas.FilterHeaderTest;
11548
11578
  export type FilterAddressTest = Components.Schemas.FilterAddressTest;
11549
11579
  export type FilterHasWordsTest = Components.Schemas.FilterHasWordsTest;
11580
+ export type FilterClassificationTest = Components.Schemas.FilterClassificationTest;
11550
11581
  export type FilterResponse = Components.Schemas.FilterResponse;
11551
11582
  export type CreateFilterInput = Components.Schemas.CreateFilterInput;
11552
11583
  export type CreateFilterResponse = Components.Schemas.CreateFilterResponse;
@@ -11709,6 +11740,7 @@ export type OutboxSchedulingPart = Components.Schemas.OutboxSchedulingPart;
11709
11740
  export type CalendarEventIndex = Components.Schemas.CalendarEventIndex;
11710
11741
  export type CalendarFeedToken = Components.Schemas.CalendarFeedToken;
11711
11742
  export type MessageLabel = Components.Schemas.MessageLabel;
11743
+ export type LabelMailbox = Components.Schemas.LabelMailbox;
11712
11744
  export type MicrosoftOAuthStartRequest = Components.Schemas.MicrosoftOAuthStartRequest;
11713
11745
  export type MicrosoftOAuthStartResponse = Components.Schemas.MicrosoftOAuthStartResponse;
11714
11746
  export type IndexType = Components.Schemas.IndexType;
@@ -11743,6 +11775,7 @@ export type FilterClauseField = Components.Schemas.FilterClauseField;
11743
11775
  export type FilterRuleMatch = Components.Schemas.FilterRuleMatch;
11744
11776
  export type FilterRuleHeader = Components.Schemas.FilterRuleHeader;
11745
11777
  export type FilterRuleAddressPart = Components.Schemas.FilterRuleAddressPart;
11778
+ export type ClassificationLabel = Components.Schemas.ClassificationLabel;
11746
11779
  export type LabelColor = Components.Schemas.LabelColor;
11747
11780
  export type OrganizeJobState = Components.Schemas.OrganizeJobState;
11748
11781
  export type CalendarColor = Components.Schemas.CalendarColor;
@@ -11763,7 +11796,6 @@ export type ClassificationPresetGroup = Components.Schemas.ClassificationPresetG
11763
11796
  export type ClassificationAdapterShape = Components.Schemas.ClassificationAdapterShape;
11764
11797
  export type ClassificationValueSource = Components.Schemas.ClassificationValueSource;
11765
11798
  export type ClassificationUnrunnableReason = Components.Schemas.ClassificationUnrunnableReason;
11766
- export type ClassificationLabel = Components.Schemas.ClassificationLabel;
11767
11799
  export type ClassificationFailureKind = Components.Schemas.ClassificationFailureKind;
11768
11800
  export type ClassificationField = Components.Schemas.ClassificationField;
11769
11801
  export type MessageCategory = Components.Schemas.MessageCategory;