@ord-api/ord-api-types 1.0.33 → 1.0.35

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.ts +87 -45
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ord-api/ord-api-types",
3
- "version": "1.0.33",
3
+ "version": "1.0.35",
4
4
  "description": "TypeScript types for ORD API - Auto-generated from OpenAPI specification",
5
5
  "main": "types.ts",
6
6
  "types": "types.ts",
package/types.ts CHANGED
@@ -1515,9 +1515,9 @@ export interface components {
1515
1515
  /** Format: int32 */
1516
1516
  maxScore: number;
1517
1517
  reviewedAnswers: components["schemas"]["IdentifiableReviewedWordAnswer"][];
1518
- accuracy: string;
1519
1518
  /** @enum {string} */
1520
1519
  grade: "S" | "A" | "B" | "C" | "D" | "NA";
1520
+ accuracy: string;
1521
1521
  };
1522
1522
  IdentifiableReviewedWordAnswer: {
1523
1523
  /** Format: uuid */
@@ -1559,9 +1559,9 @@ export interface components {
1559
1559
  /** Format: int32 */
1560
1560
  maxScore: number;
1561
1561
  reviewedAnswers: components["schemas"]["ReviewedSentencesWritingSingleTopic"][];
1562
- accuracy: string;
1563
1562
  /** @enum {string} */
1564
1563
  grade: "S" | "A" | "B" | "C" | "D" | "NA";
1564
+ accuracy: string;
1565
1565
  };
1566
1566
  ReviewedSentencesWritingSingleTopic: {
1567
1567
  /** Format: uuid */
@@ -1653,9 +1653,9 @@ export interface components {
1653
1653
  /** Format: int32 */
1654
1654
  maxScore: number;
1655
1655
  reviewedAnswers: components["schemas"]["CrosswordReviewedAnswers"];
1656
- accuracy: string;
1657
1656
  /** @enum {string} */
1658
1657
  grade: "S" | "A" | "B" | "C" | "D" | "NA";
1658
+ accuracy: string;
1659
1659
  };
1660
1660
  ReviewedWordAnswer: {
1661
1661
  expectedAnswer: string;
@@ -1691,6 +1691,7 @@ export interface components {
1691
1691
  * @enum {string}
1692
1692
  */
1693
1693
  register: "FORMAL" | "NEUTRAL" | "COLLOQUIAL";
1694
+ nativeLanguageEquivalent: string;
1694
1695
  };
1695
1696
  AnnotatedPhraseTip: {
1696
1697
  phrase: string;
@@ -1706,6 +1707,7 @@ export interface components {
1706
1707
  * @enum {string}
1707
1708
  */
1708
1709
  register: "FORMAL" | "NEUTRAL" | "COLLOQUIAL";
1710
+ nativeLanguageEquivalent: string;
1709
1711
  };
1710
1712
  AnnotatedVocabularyTip: {
1711
1713
  word: string;
@@ -2064,53 +2066,65 @@ export interface components {
2064
2066
  updatedAt: string;
2065
2067
  details?: components["schemas"]["WordDetailsCompactDTO"];
2066
2068
  };
2069
+ ConversationSummaryDTO: {
2070
+ /** Format: uuid */
2071
+ id: string;
2072
+ topic: string;
2073
+ /**
2074
+ * @description Supported languages in the platform
2075
+ * @enum {string}
2076
+ */
2077
+ language: "POLISH" | "ENGLISH" | "GERMAN" | "FRENCH" | "SPANISH" | "ITALIAN" | "NORWEGIAN" | "RUSSIAN" | "SLOVENIAN";
2078
+ /** @enum {string} */
2079
+ proficiencyLevel: "A1" | "A2" | "B1" | "B2" | "C1" | "C2";
2080
+ /** @enum {string} */
2081
+ type: "SMALL_TALK" | "SCENARIO_ROLEPLAY" | "EXAM_PRACTICE" | "TOPIC_EXPLORATION" | "OXFORD_DEBATE";
2082
+ /** @enum {string} */
2083
+ aiTone: "FRIENDLY" | "FORMAL" | "HUMOROUS" | "NEUTRAL" | "ENCOURAGING" | "CHALLENGING";
2084
+ aiInterlocutorName: string;
2085
+ aiInterlocutorAvatarId: string;
2086
+ additionalContext?: string;
2087
+ /** Format: date-time */
2088
+ createdAt: string;
2089
+ /** Format: date-time */
2090
+ updatedAt: string;
2091
+ /**
2092
+ * @description Grouping bucket based on last activity (UTC)
2093
+ * @enum {string}
2094
+ */
2095
+ recencyBucket: "TODAY" | "YESTERDAY" | "THIS_WEEK" | "THIS_MONTH" | "LATER";
2096
+ };
2067
2097
  /** @enum {string} */
2068
- LanguageProficiencyLevel: "A1" | "A2" | "B1" | "B2" | "C1" | "C2";
2069
- /**
2070
- * @description Supported languages in the platform
2071
- * @enum {string}
2072
- */
2073
- LanguageName: "POLISH" | "ENGLISH" | "GERMAN" | "FRENCH" | "SPANISH" | "ITALIAN" | "NORWEGIAN" | "RUSSIAN" | "SLOVENIAN";
2074
- /** @enum {string} */
2075
- Gender: "MALE" | "FEMALE";
2076
- /** @enum {string} */
2077
- GetAllWordsSortOptions: "CREATED_AT" | "SOURCE_WORD";
2078
- /** @enum {string} */
2079
- WordToggleableProperty: "IS_BOOKMARKED";
2098
+ CrosswordWordDirection: "HORIZONTAL" | "VERTICAL";
2080
2099
  /** @enum {string} */
2081
- WordCollocationFrequency: "VERY_COMMON" | "COMMON" | "OCCASIONAL";
2100
+ WordAnswerScore: "CORRECT" | "HALF_CORRECT" | "INCORRECT";
2082
2101
  /** @enum {string} */
2083
- WordGender: "MASCULINE" | "FEMININE" | "NEUTER";
2084
- /**
2085
- * @description Type of word or expression
2086
- * @enum {string}
2087
- */
2088
- WordType: "NOUN" | "VERB" | "ADJECTIVE" | "ADVERB" | "IDIOM" | "PHRASE";
2089
- /**
2090
- * @description Extra marks or tags for word classification by register or domain
2091
- * @enum {string}
2092
- */
2093
- WordExtraMark: "OFFENSIVE" | "SLANG" | "FORMAL" | "INFORMAL" | "SCIENTIFIC" | "TECHNICAL" | "LEGAL" | "MEDICAL" | "COLLOQUIAL" | "POETIC";
2102
+ GameDifficulty: "EASY" | "MEDIUM" | "HARD";
2094
2103
  /** @enum {string} */
2095
- SortDirection: "ASC" | "DESC";
2104
+ GameType: "WORDS_TYPING" | "CROSSWORD" | "SENTENCES_WRITING";
2096
2105
  /** @enum {string} */
2097
2106
  GameResult: "COMPLETED" | "CANCELLED";
2098
2107
  /** @enum {string} */
2099
- GameDifficulty: "EASY" | "MEDIUM" | "HARD";
2100
- /** @enum {string} */
2101
2108
  GameGrade: "S" | "A" | "B" | "C" | "D" | "NA";
2102
2109
  /** @enum {string} */
2103
- GameType: "WORDS_TYPING" | "CROSSWORD" | "SENTENCES_WRITING";
2110
+ ConversationMessageStrengthType: "GRAMMAR" | "VOCABULARY" | "FLUENCY" | "PRAGMATICS" | "COMMUNICATION";
2104
2111
  /** @enum {string} */
2105
- CrosswordWordDirection: "HORIZONTAL" | "VERTICAL";
2112
+ ConversationMessageSuggestionType: "VOCABULARY" | "STRUCTURE";
2106
2113
  /** @enum {string} */
2107
- WordAnswerScore: "CORRECT" | "HALF_CORRECT" | "INCORRECT";
2114
+ ConversationMessageErrorType: "GRAMMAR" | "VOCABULARY" | "SPELLING" | "PUNCTUATION";
2108
2115
  /** @enum {string} */
2109
- UserActivityFrequency: "DAILY" | "WEEKLY" | "MONTHLY" | "NON_PERIODIC";
2116
+ ConversationMessageMistakeSeverity: "MINOR" | "MODERATE" | "CRITICAL";
2110
2117
  /** @enum {string} */
2111
- UserActivityType: "CROSSWORD_GAME_COMPLETED_FLAWLESSLY" | "CROSSWORD_GAME_COMPLETED_WITH_MISTAKES" | "WORDS_TYPING_GAME_COMPLETED_FLAWLESSLY" | "WORDS_TYPING_GAME_COMPLETED_WITH_MISTAKES" | "SENTENCES_WRITING_GAME_COMPLETED_FLAWLESSLY" | "SENTENCES_WRITING_GAME_COMPLETED_WITH_MISTAKES" | "GAME_QUIT" | "WORDS_ADDED_IN_ONE_DAY_10" | "WORDS_ADDED_IN_ONE_WEEK_50" | "WORD_COMPLETED" | "WORDS_COMPLETED_IN_ONE_DAY_10" | "WORDS_COMPLETED_IN_ONE_WEEK_30";
2118
+ ConversationType: "SMALL_TALK" | "SCENARIO_ROLEPLAY" | "EXAM_PRACTICE" | "TOPIC_EXPLORATION" | "OXFORD_DEBATE";
2119
+ /**
2120
+ * @description Grouping bucket based on last activity (UTC)
2121
+ * @enum {string}
2122
+ */
2123
+ RecencyBucket: "TODAY" | "YESTERDAY" | "THIS_WEEK" | "THIS_MONTH" | "LATER";
2112
2124
  /** @enum {string} */
2113
- ConversationMessageSender: "USER" | "AI";
2125
+ ConversationAIBotAvatar: "AVATAR_DEFAULT" | "AVATAR_ALPHA" | "AVATAR_BETA" | "AVATAR_GAMMA" | "AVATAR_DELTA" | "AVATAR_EPSILON" | "AVATAR_ZETA" | "AVATAR_ETA" | "AVATAR_THETA";
2126
+ /** @enum {string} */
2127
+ ConversationTone: "FRIENDLY" | "FORMAL" | "HUMOROUS" | "NEUTRAL" | "ENCOURAGING" | "CHALLENGING";
2114
2128
  /**
2115
2129
  * @description Formality register indicator for learning tips
2116
2130
  * @enum {string}
@@ -2122,19 +2136,40 @@ export interface components {
2122
2136
  */
2123
2137
  PhraseType: "IDIOMATIC" | "LITERAL";
2124
2138
  /** @enum {string} */
2125
- ConversationMessageMistakeSeverity: "MINOR" | "MODERATE" | "CRITICAL";
2139
+ ConversationMessageSender: "USER" | "AI";
2126
2140
  /** @enum {string} */
2127
- ConversationMessageSuggestionType: "VOCABULARY" | "STRUCTURE";
2141
+ UserActivityType: "CROSSWORD_GAME_COMPLETED_FLAWLESSLY" | "CROSSWORD_GAME_COMPLETED_WITH_MISTAKES" | "WORDS_TYPING_GAME_COMPLETED_FLAWLESSLY" | "WORDS_TYPING_GAME_COMPLETED_WITH_MISTAKES" | "SENTENCES_WRITING_GAME_COMPLETED_FLAWLESSLY" | "SENTENCES_WRITING_GAME_COMPLETED_WITH_MISTAKES" | "GAME_QUIT" | "WORDS_ADDED_IN_ONE_DAY_10" | "WORDS_ADDED_IN_ONE_WEEK_50" | "WORD_COMPLETED" | "WORDS_COMPLETED_IN_ONE_DAY_10" | "WORDS_COMPLETED_IN_ONE_WEEK_30";
2128
2142
  /** @enum {string} */
2129
- ConversationMessageStrengthType: "GRAMMAR" | "VOCABULARY" | "FLUENCY" | "PRAGMATICS" | "COMMUNICATION";
2143
+ UserActivityFrequency: "DAILY" | "WEEKLY" | "MONTHLY" | "NON_PERIODIC";
2130
2144
  /** @enum {string} */
2131
- ConversationMessageErrorType: "GRAMMAR" | "VOCABULARY" | "SPELLING" | "PUNCTUATION";
2145
+ LanguageProficiencyLevel: "A1" | "A2" | "B1" | "B2" | "C1" | "C2";
2146
+ /**
2147
+ * @description Supported languages in the platform
2148
+ * @enum {string}
2149
+ */
2150
+ LanguageName: "POLISH" | "ENGLISH" | "GERMAN" | "FRENCH" | "SPANISH" | "ITALIAN" | "NORWEGIAN" | "RUSSIAN" | "SLOVENIAN";
2132
2151
  /** @enum {string} */
2133
- ConversationTone: "FRIENDLY" | "FORMAL" | "HUMOROUS" | "NEUTRAL" | "ENCOURAGING" | "CHALLENGING";
2152
+ Gender: "MALE" | "FEMALE";
2134
2153
  /** @enum {string} */
2135
- ConversationAIBotAvatar: "AVATAR_DEFAULT" | "AVATAR_ALPHA" | "AVATAR_BETA" | "AVATAR_GAMMA" | "AVATAR_DELTA" | "AVATAR_EPSILON" | "AVATAR_ZETA" | "AVATAR_ETA" | "AVATAR_THETA";
2154
+ WordToggleableProperty: "IS_BOOKMARKED";
2136
2155
  /** @enum {string} */
2137
- ConversationType: "SMALL_TALK" | "SCENARIO_ROLEPLAY" | "EXAM_PRACTICE" | "TOPIC_EXPLORATION" | "OXFORD_DEBATE";
2156
+ GetAllWordsSortOptions: "CREATED_AT" | "SOURCE_WORD";
2157
+ /** @enum {string} */
2158
+ WordCollocationFrequency: "VERY_COMMON" | "COMMON" | "OCCASIONAL";
2159
+ /** @enum {string} */
2160
+ WordGender: "MASCULINE" | "FEMININE" | "NEUTER";
2161
+ /**
2162
+ * @description Extra marks or tags for word classification by register or domain
2163
+ * @enum {string}
2164
+ */
2165
+ WordExtraMark: "OFFENSIVE" | "SLANG" | "FORMAL" | "INFORMAL" | "SCIENTIFIC" | "TECHNICAL" | "LEGAL" | "MEDICAL" | "COLLOQUIAL" | "POETIC";
2166
+ /**
2167
+ * @description Type of word or expression
2168
+ * @enum {string}
2169
+ */
2170
+ WordType: "NOUN" | "VERB" | "ADJECTIVE" | "ADVERB" | "IDIOM" | "PHRASE";
2171
+ /** @enum {string} */
2172
+ SortDirection: "ASC" | "DESC";
2138
2173
  };
2139
2174
  responses: never;
2140
2175
  parameters: never;
@@ -3245,7 +3280,14 @@ export interface operations {
3245
3280
  };
3246
3281
  getConversations: {
3247
3282
  parameters: {
3248
- query?: never;
3283
+ query?: {
3284
+ /** @description Case-insensitive substring search on topic and interlocutor name */
3285
+ search?: string;
3286
+ /** @description Filter by recency bucket */
3287
+ recencyBucket?: "TODAY" | "YESTERDAY" | "THIS_WEEK" | "THIS_MONTH" | "LATER";
3288
+ /** @description Filter by conversation type */
3289
+ type?: "SMALL_TALK" | "SCENARIO_ROLEPLAY" | "EXAM_PRACTICE" | "TOPIC_EXPLORATION" | "OXFORD_DEBATE";
3290
+ };
3249
3291
  header?: never;
3250
3292
  path?: never;
3251
3293
  cookie?: never;
@@ -3258,7 +3300,7 @@ export interface operations {
3258
3300
  [name: string]: unknown;
3259
3301
  };
3260
3302
  content: {
3261
- "*/*": components["schemas"]["ConversationDTO"][];
3303
+ "*/*": components["schemas"]["ConversationSummaryDTO"][];
3262
3304
  };
3263
3305
  };
3264
3306
  /** @description Bad Request */