feat(api): api update (#60)

Author: stainless-app[bot]

src/codex/resources/projects/entries.py

@@ -138,6 +138,7 @@ def update(
         *,
         project_id: str,
         answer: Optional[str] | NotGiven = NOT_GIVEN,
+        frequency_count: Optional[int] | NotGiven = NOT_GIVEN,
         question: Optional[str] | NotGiven = NOT_GIVEN,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
@@ -167,6 +168,7 @@ def update(
             body=maybe_transform(
                 {
                     "answer": answer,
+                    "frequency_count": frequency_count,
                     "question": question,
                 },
                 entry_update_params.EntryUpdateParams,
@@ -318,8 +320,10 @@ def query(
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> Optional[Entry]:
-        """
-        Query knowledge for a project.
+        """Query knowledge for a project.
+
+        Also increments the frequency_count for the
+        matching entry if found.
 
         Returns the matching entry if found and answered, otherwise returns None. This
         allows the client to distinguish between: (1) no matching question found
@@ -451,6 +455,7 @@ async def update(
         *,
         project_id: str,
         answer: Optional[str] | NotGiven = NOT_GIVEN,
+        frequency_count: Optional[int] | NotGiven = NOT_GIVEN,
         question: Optional[str] | NotGiven = NOT_GIVEN,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
@@ -480,6 +485,7 @@ async def update(
             body=await async_maybe_transform(
                 {
                     "answer": answer,
+                    "frequency_count": frequency_count,
                     "question": question,
                 },
                 entry_update_params.EntryUpdateParams,
@@ -631,8 +637,10 @@ async def query(
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> Optional[Entry]:
-        """
-        Query knowledge for a project.
+        """Query knowledge for a project.
+
+        Also increments the frequency_count for the
+        matching entry if found.
 
         Returns the matching entry if found and answered, otherwise returns None. This
         allows the client to distinguish between: (1) no matching question found

src/codex/types/projects/entry.py

@@ -18,3 +18,5 @@ class Entry(BaseModel):
     answer: Optional[str] = None
 
     answered_at: Optional[datetime] = None
+
+    frequency_count: Optional[int] = None

src/codex/types/projects/entry_update_params.py

@@ -13,4 +13,6 @@ class EntryUpdateParams(TypedDict, total=False):
 
     answer: Optional[str]
 
+    frequency_count: Optional[int]
+
     question: Optional[str]

tests/api_resources/projects/test_entries.py

@@ -144,6 +144,7 @@ def test_method_update_with_all_params(self, client: Codex) -> None:
             entry_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
             project_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
             answer="answer",
+            frequency_count=0,
             question="question",
         )
         assert_matches_type(Entry, entry, path=["response"])
@@ -519,6 +520,7 @@ async def test_method_update_with_all_params(self, async_client: AsyncCodex) ->
             entry_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
             project_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
             answer="answer",
+            frequency_count=0,
             question="question",
         )
         assert_matches_type(Entry, entry, path=["response"])