fix(contexts): replace hyper.contexts.list with hyper.contexts.all

Author: niloysikdar

README.md

@@ -137,10 +137,10 @@ Now you're ready to start querying language models with your own custom contexts
 
 Hypercode allows you to programmatically manage your contexts that are created inside the [Hyper App](https://app.gethyper.ai). You can get information about the created contexts, and more methods are coming soon. More information about contexts can be found [here](https://docs.gethyper.ai/context).
 
-**Here's a quick example of how you can use Hypercode to list down all the contexts:**
+**Here's a quick example of how you can use Hypercode to get all the contexts:**
 
 ```javascript
-const { data: contexts, error } = await hyper.contexts.list();
+const { data: contexts, error } = await hyper.contexts.all();
 
 console.log(contexts); // [{ id: 'context-id-1', name: 'Context 1', created_at: '2023-10-28T04:28:13.971776+00:00' }, { id: 'context-id-2', name: 'Context 2', created_at: '2023-11-02T22:18:44.978052+00:00' }]
 ```

src/contexts/contexts.test.ts

@@ -36,7 +36,7 @@ describe('Hypercode contexts API methods', () => {
         status: 200,
       });
 
-      const result = await hyper.contexts.list();
+      const result = await hyper.contexts.all();
 
       expect(result.data).toEqual(expectedResult);
       expect(fetchMock).toHaveBeenLastCalledWith(

src/contexts/contexts.ts

@@ -8,10 +8,10 @@ export class Contexts {
    * Get all of the available contexts. More information: https://docs.gethyper.ai/context#get-v1-contexts
    * @returns All of the available contexts in the Hyper app (https://app.gethyper.ai)
    * @example
-   * const { data, error } = await hyper.contexts.list();
+   * const { data, error } = await hyper.contexts.all();
    * console.log(data);
    */
-  async list() {
+  async all() {
     const res = await this.hyper.get<AllContexts>({
       endpoint: '/contexts',
     });

src/hyper.ts

@@ -44,7 +44,7 @@ export class Hyper {
   /**
    * Hyper Contexts API. Context groups in the Hyper app serve as collections of data aggregated from files, web URLs, and third-party integrations. They play a crucial role in refining search results and tailoring the contextual data provided to large language models. More information: https://docs.gethyper.ai/context
    * @example
-   * const { data, error } = await hyper.contexts.list();
+   * const { data, error } = await hyper.contexts.all();
    */
   readonly contexts = new Contexts(this);
 

src/search/@types/index.ts

@@ -1,6 +1,6 @@
 export type MethodParamsOptions = {
   /**
-   * The context ID to be used for the request, you can get all context IDs by calling `hyper.contexts.list()` and then using the `id` field from the response.
+   * The context ID to be used for the request, you can get all context IDs by calling `hyper.contexts.all()` and then using the `id` field from the response.
    */
   contextId: string;
 };

src/types/@types/index.ts

@@ -12,7 +12,7 @@ export type AllowedTypes =
 
 export type MethodParamsOptions = {
   /**
-   * The context ID to be used for the request, you can get all context IDs by calling `hyper.contexts.list()` and then using the `id` field from the response.
+   * The context ID to be used for the request, you can get all context IDs by calling `hyper.contexts.all()` and then using the `id` field from the response.
    */
   contextId: string;
 };