skyflow-flowvault-python 1.0.0__py3-none-any.whl

skyflow/generated/rest/records/client.py

@@ -0,0 +1,685 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ..core.request_options import RequestOptions
+from ..types.column_redactions import ColumnRedactions
+from ..types.delete_response import DeleteResponse
+from ..types.get_request_data import GetRequestData
+from ..types.get_response import GetResponse
+from ..types.insert_record_data import InsertRecordData
+from ..types.insert_response import InsertResponse
+from ..types.unique_value import UniqueValue
+from ..types.update_record_data import UpdateRecordData
+from ..types.update_response import UpdateResponse
+from ..types.upsert import Upsert
+from .raw_client import AsyncRawRecordsClient, RawRecordsClient
+from .types.update_request_update_type import UpdateRequestUpdateType
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class RecordsClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._raw_client = RawRecordsClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> RawRecordsClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawRecordsClient
+        """
+        return self._raw_client
+
+    def delete_records(
+        self,
+        *,
+        vault_id: str,
+        table_name: typing.Optional[str] = OMIT,
+        skyflow_i_ds: typing.Optional[typing.Sequence[str]] = OMIT,
+        unique_values: typing.Optional[typing.Sequence[UniqueValue]] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> DeleteResponse:
+        """
+        Deletes records from a vault.
+
+        Parameters
+        ----------
+        vault_id : str
+            ID of the vault.
+
+        table_name : typing.Optional[str]
+            Name of the table.
+
+        skyflow_i_ds : typing.Optional[typing.Sequence[str]]
+            Skyflow IDs of the records to delete.
+
+        unique_values : typing.Optional[typing.Sequence[UniqueValue]]
+            List of unique constraint values to query records by data.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        DeleteResponse
+            OK
+
+        Examples
+        --------
+        from skyflow import SkyflowAuth
+
+        client = SkyflowAuth(
+            token="YOUR_TOKEN",
+        )
+        client.records.delete_records(
+            vault_id="d408485953784308a000f8dcf81901ef",
+        )
+        """
+        _response = self._raw_client.delete_records(
+            vault_id=vault_id,
+            table_name=table_name,
+            skyflow_i_ds=skyflow_i_ds,
+            unique_values=unique_values,
+            request_options=request_options,
+        )
+        return _response.data
+
+    def get_records(
+        self,
+        *,
+        vault_id: str,
+        table_name: typing.Optional[str] = OMIT,
+        skyflow_i_ds: typing.Optional[typing.Sequence[str]] = OMIT,
+        column_redactions: typing.Optional[typing.Sequence[ColumnRedactions]] = OMIT,
+        columns: typing.Optional[typing.Sequence[str]] = OMIT,
+        limit: typing.Optional[int] = OMIT,
+        offset: typing.Optional[int] = OMIT,
+        unique_values: typing.Optional[typing.Sequence[UniqueValue]] = OMIT,
+        records: typing.Optional[typing.Sequence[GetRequestData]] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> GetResponse:
+        """
+        Returns the specified records from a vault.
+
+        Parameters
+        ----------
+        vault_id : str
+            ID of the vault.
+
+        table_name : typing.Optional[str]
+            Name of the table to perform the operation on.
+
+        skyflow_i_ds : typing.Optional[typing.Sequence[str]]
+            Skyflow IDs of the records to return. Either `skyflowIDs` or `uniqueValues` are required. If both are provided, the request fails.
+
+        column_redactions : typing.Optional[typing.Sequence[ColumnRedactions]]
+            List of columns to redact.
+
+        columns : typing.Optional[typing.Sequence[str]]
+            List of columns to return.
+
+        limit : typing.Optional[int]
+            Limit for the number of records to be fetched.
+
+        offset : typing.Optional[int]
+            Offset for the number of records to be fetched.
+
+        unique_values : typing.Optional[typing.Sequence[UniqueValue]]
+            List of unique constraint values to query records by data.
+
+        records : typing.Optional[typing.Sequence[GetRequestData]]
+            List of records to be fetched. This field contains tableName and skyflowIDs belonging to the table.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        GetResponse
+            OK
+
+        Examples
+        --------
+        from skyflow import SkyflowAuth
+
+        client = SkyflowAuth(
+            token="YOUR_TOKEN",
+        )
+        client.records.get_records(
+            vault_id="d408485953784308a000f8dcf81901ef",
+        )
+        """
+        _response = self._raw_client.get_records(
+            vault_id=vault_id,
+            table_name=table_name,
+            skyflow_i_ds=skyflow_i_ds,
+            column_redactions=column_redactions,
+            columns=columns,
+            limit=limit,
+            offset=offset,
+            unique_values=unique_values,
+            records=records,
+            request_options=request_options,
+        )
+        return _response.data
+
+    def insert_records(
+        self,
+        *,
+        vault_id: str,
+        table_name: str,
+        records: typing.Sequence[InsertRecordData],
+        upsert: typing.Optional[Upsert] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> InsertResponse:
+        """
+        Inserts new records into a vault.
+
+        Parameters
+        ----------
+        vault_id : str
+            ID of the vault.
+
+        table_name : str
+            Name of the table to perform the operation on. Can be defined at both the request body level and individual record level. If provided at both levels, the record-level `tableName` takes precedence.
+
+        records : typing.Sequence[InsertRecordData]
+            Data to insert as a list of records.
+
+        upsert : typing.Optional[Upsert]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        InsertResponse
+            OK
+
+        Examples
+        --------
+        from skyflow import InsertRecordData, SkyflowAuth
+
+        client = SkyflowAuth(
+            token="YOUR_TOKEN",
+        )
+        client.records.insert_records(
+            vault_id="d408485953784308a000f8dcf81901ef",
+            table_name="employees",
+            records=[
+                InsertRecordData(
+                    data={
+                        "name": "Vivek1",
+                        "email": "vivek.varshney@skyflow.com",
+                        "age": 23,
+                        "adult": True,
+                        "address": {
+                            "street": "Bata Gali",
+                            "city": "Aligarh",
+                            "state": "UP",
+                            "postal_code": 202001,
+                            "country": "India",
+                            "phone_numbers": [
+                                {"type": "home", "number": [1234, 5678]},
+                                {"type": "work", "number": [4321, 8765]},
+                            ],
+                        },
+                    },
+                ),
+                InsertRecordData(
+                    data={
+                        "name": "Asad1",
+                        "email": "asad.public@gmail.com",
+                        "age": 16,
+                        "adult": False,
+                        "address": {
+                            "street": "Sarojini",
+                            "city": "Deoria",
+                            "state": "UP",
+                            "postal_code": 274001,
+                            "country": "India",
+                            "phone_numbers": [
+                                {"type": "home", "number": [7890, 3456]},
+                                {"type": "work", "number": [9087, 6543]},
+                            ],
+                        },
+                    },
+                ),
+            ],
+        )
+        """
+        _response = self._raw_client.insert_records(
+            vault_id=vault_id, table_name=table_name, records=records, upsert=upsert, request_options=request_options
+        )
+        return _response.data
+
+    def update_records(
+        self,
+        *,
+        vault_id: str,
+        table_name: str,
+        records: typing.Sequence[UpdateRecordData],
+        update_type: typing.Optional[UpdateRequestUpdateType] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> UpdateResponse:
+        """
+        Updates the specified records in a vault.
+
+        Parameters
+        ----------
+        vault_id : str
+            ID of the vault.
+
+        table_name : str
+            Name of the table.
+
+        records : typing.Sequence[UpdateRecordData]
+            Data to update as a list of records.
+
+        update_type : typing.Optional[UpdateRequestUpdateType]
+            Type of update operation to perform.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        UpdateResponse
+            OK
+
+        Examples
+        --------
+        from skyflow import SkyflowAuth, UpdateRecordData
+
+        client = SkyflowAuth(
+            token="YOUR_TOKEN",
+        )
+        client.records.update_records(
+            vault_id="d408485953784308a000f8dcf81901ef",
+            table_name="employees",
+            records=[
+                UpdateRecordData(
+                    skyflow_id="97cdd1af-02ac-47eb-ab0d-8339dbef6ccb",
+                    data={
+                        "name": "Vivek",
+                        "email": "asad.public5@gmail.com",
+                        "age": 25,
+                        "adult": True,
+                        "address": {"city": "aligarh", "country": "India"},
+                    },
+                ),
+                UpdateRecordData(
+                    skyflow_id="aed32bbc-e7a4-4c7b-8c88-7f52ce8cb066",
+                    data={
+                        "name": "Asad",
+                        "email": "asad.public7@gmail.com",
+                        "age": 24,
+                        "adult": False,
+                        "address": {"city": "deoria", "country": "India"},
+                    },
+                ),
+            ],
+        )
+        """
+        _response = self._raw_client.update_records(
+            vault_id=vault_id,
+            table_name=table_name,
+            records=records,
+            update_type=update_type,
+            request_options=request_options,
+        )
+        return _response.data
+
+
+class AsyncRecordsClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._raw_client = AsyncRawRecordsClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> AsyncRawRecordsClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawRecordsClient
+        """
+        return self._raw_client
+
+    async def delete_records(
+        self,
+        *,
+        vault_id: str,
+        table_name: typing.Optional[str] = OMIT,
+        skyflow_i_ds: typing.Optional[typing.Sequence[str]] = OMIT,
+        unique_values: typing.Optional[typing.Sequence[UniqueValue]] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> DeleteResponse:
+        """
+        Deletes records from a vault.
+
+        Parameters
+        ----------
+        vault_id : str
+            ID of the vault.
+
+        table_name : typing.Optional[str]
+            Name of the table.
+
+        skyflow_i_ds : typing.Optional[typing.Sequence[str]]
+            Skyflow IDs of the records to delete.
+
+        unique_values : typing.Optional[typing.Sequence[UniqueValue]]
+            List of unique constraint values to query records by data.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        DeleteResponse
+            OK
+
+        Examples
+        --------
+        import asyncio
+
+        from skyflow import AsyncSkyflowAuth
+
+        client = AsyncSkyflowAuth(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.records.delete_records(
+                vault_id="d408485953784308a000f8dcf81901ef",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.delete_records(
+            vault_id=vault_id,
+            table_name=table_name,
+            skyflow_i_ds=skyflow_i_ds,
+            unique_values=unique_values,
+            request_options=request_options,
+        )
+        return _response.data
+
+    async def get_records(
+        self,
+        *,
+        vault_id: str,
+        table_name: typing.Optional[str] = OMIT,
+        skyflow_i_ds: typing.Optional[typing.Sequence[str]] = OMIT,
+        column_redactions: typing.Optional[typing.Sequence[ColumnRedactions]] = OMIT,
+        columns: typing.Optional[typing.Sequence[str]] = OMIT,
+        limit: typing.Optional[int] = OMIT,
+        offset: typing.Optional[int] = OMIT,
+        unique_values: typing.Optional[typing.Sequence[UniqueValue]] = OMIT,
+        records: typing.Optional[typing.Sequence[GetRequestData]] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> GetResponse:
+        """
+        Returns the specified records from a vault.
+
+        Parameters
+        ----------
+        vault_id : str
+            ID of the vault.
+
+        table_name : typing.Optional[str]
+            Name of the table to perform the operation on.
+
+        skyflow_i_ds : typing.Optional[typing.Sequence[str]]
+            Skyflow IDs of the records to return. Either `skyflowIDs` or `uniqueValues` are required. If both are provided, the request fails.
+
+        column_redactions : typing.Optional[typing.Sequence[ColumnRedactions]]
+            List of columns to redact.
+
+        columns : typing.Optional[typing.Sequence[str]]
+            List of columns to return.
+
+        limit : typing.Optional[int]
+            Limit for the number of records to be fetched.
+
+        offset : typing.Optional[int]
+            Offset for the number of records to be fetched.
+
+        unique_values : typing.Optional[typing.Sequence[UniqueValue]]
+            List of unique constraint values to query records by data.
+
+        records : typing.Optional[typing.Sequence[GetRequestData]]
+            List of records to be fetched. This field contains tableName and skyflowIDs belonging to the table.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        GetResponse
+            OK
+
+        Examples
+        --------
+        import asyncio
+
+        from skyflow import AsyncSkyflowAuth
+
+        client = AsyncSkyflowAuth(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.records.get_records(
+                vault_id="d408485953784308a000f8dcf81901ef",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.get_records(
+            vault_id=vault_id,
+            table_name=table_name,
+            skyflow_i_ds=skyflow_i_ds,
+            column_redactions=column_redactions,
+            columns=columns,
+            limit=limit,
+            offset=offset,
+            unique_values=unique_values,
+            records=records,
+            request_options=request_options,
+        )
+        return _response.data
+
+    async def insert_records(
+        self,
+        *,
+        vault_id: str,
+        table_name: str,
+        records: typing.Sequence[InsertRecordData],
+        upsert: typing.Optional[Upsert] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> InsertResponse:
+        """
+        Inserts new records into a vault.
+
+        Parameters
+        ----------
+        vault_id : str
+            ID of the vault.
+
+        table_name : str
+            Name of the table to perform the operation on. Can be defined at both the request body level and individual record level. If provided at both levels, the record-level `tableName` takes precedence.
+
+        records : typing.Sequence[InsertRecordData]
+            Data to insert as a list of records.
+
+        upsert : typing.Optional[Upsert]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        InsertResponse
+            OK
+
+        Examples
+        --------
+        import asyncio
+
+        from skyflow import AsyncSkyflowAuth, InsertRecordData
+
+        client = AsyncSkyflowAuth(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.records.insert_records(
+                vault_id="d408485953784308a000f8dcf81901ef",
+                table_name="employees",
+                records=[
+                    InsertRecordData(
+                        data={
+                            "name": "Vivek1",
+                            "email": "vivek.varshney@skyflow.com",
+                            "age": 23,
+                            "adult": True,
+                            "address": {
+                                "street": "Bata Gali",
+                                "city": "Aligarh",
+                                "state": "UP",
+                                "postal_code": 202001,
+                                "country": "India",
+                                "phone_numbers": [
+                                    {"type": "home", "number": [1234, 5678]},
+                                    {"type": "work", "number": [4321, 8765]},
+                                ],
+                            },
+                        },
+                    ),
+                    InsertRecordData(
+                        data={
+                            "name": "Asad1",
+                            "email": "asad.public@gmail.com",
+                            "age": 16,
+                            "adult": False,
+                            "address": {
+                                "street": "Sarojini",
+                                "city": "Deoria",
+                                "state": "UP",
+                                "postal_code": 274001,
+                                "country": "India",
+                                "phone_numbers": [
+                                    {"type": "home", "number": [7890, 3456]},
+                                    {"type": "work", "number": [9087, 6543]},
+                                ],
+                            },
+                        },
+                    ),
+                ],
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.insert_records(
+            vault_id=vault_id, table_name=table_name, records=records, upsert=upsert, request_options=request_options
+        )
+        return _response.data
+
+    async def update_records(
+        self,
+        *,
+        vault_id: str,
+        table_name: str,
+        records: typing.Sequence[UpdateRecordData],
+        update_type: typing.Optional[UpdateRequestUpdateType] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> UpdateResponse:
+        """
+        Updates the specified records in a vault.
+
+        Parameters
+        ----------
+        vault_id : str
+            ID of the vault.
+
+        table_name : str
+            Name of the table.
+
+        records : typing.Sequence[UpdateRecordData]
+            Data to update as a list of records.
+
+        update_type : typing.Optional[UpdateRequestUpdateType]
+            Type of update operation to perform.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        UpdateResponse
+            OK
+
+        Examples
+        --------
+        import asyncio
+
+        from skyflow import AsyncSkyflowAuth, UpdateRecordData
+
+        client = AsyncSkyflowAuth(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.records.update_records(
+                vault_id="d408485953784308a000f8dcf81901ef",
+                table_name="employees",
+                records=[
+                    UpdateRecordData(
+                        skyflow_id="97cdd1af-02ac-47eb-ab0d-8339dbef6ccb",
+                        data={
+                            "name": "Vivek",
+                            "email": "asad.public5@gmail.com",
+                            "age": 25,
+                            "adult": True,
+                            "address": {"city": "aligarh", "country": "India"},
+                        },
+                    ),
+                    UpdateRecordData(
+                        skyflow_id="aed32bbc-e7a4-4c7b-8c88-7f52ce8cb066",
+                        data={
+                            "name": "Asad",
+                            "email": "asad.public7@gmail.com",
+                            "age": 24,
+                            "adult": False,
+                            "address": {"city": "deoria", "country": "India"},
+                        },
+                    ),
+                ],
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.update_records(
+            vault_id=vault_id,
+            table_name=table_name,
+            records=records,
+            update_type=update_type,
+            request_options=request_options,
+        )
+        return _response.data