brevo-python 4.0.1__py3-none-any.whl

brevo/companies/client.py

@@ -0,0 +1,994 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from .. import core
+from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ..core.request_options import RequestOptions
+from ..types.company import Company
+from .raw_client import AsyncRawCompaniesClient, RawCompaniesClient
+from .types.get_companies_request_sort import GetCompaniesRequestSort
+from .types.get_companies_response import GetCompaniesResponse
+from .types.get_crm_attributes_companies_response_item import GetCrmAttributesCompaniesResponseItem
+from .types.post_companies_import_response import PostCompaniesImportResponse
+from .types.post_companies_response import PostCompaniesResponse
+from .types.post_crm_attributes_request_attribute_type import PostCrmAttributesRequestAttributeType
+from .types.post_crm_attributes_request_object_type import PostCrmAttributesRequestObjectType
+from .types.post_crm_attributes_response import PostCrmAttributesResponse
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class CompaniesClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._raw_client = RawCompaniesClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> RawCompaniesClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawCompaniesClient
+        """
+        return self._raw_client
+
+    def get_all_companies(
+        self,
+        *,
+        filters: typing.Optional[str] = None,
+        linked_contacts_ids: typing.Optional[int] = None,
+        linked_deals_ids: typing.Optional[str] = None,
+        modified_since: typing.Optional[str] = None,
+        created_since: typing.Optional[str] = None,
+        page: typing.Optional[int] = None,
+        limit: typing.Optional[int] = None,
+        sort: typing.Optional[GetCompaniesRequestSort] = None,
+        sort_by: typing.Optional[str] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> GetCompaniesResponse:
+        """
+        Parameters
+        ----------
+        filters : typing.Optional[str]
+            Filter by attrbutes. If you have filter for owner on your side please send it as {"attributes.owner":"6299dcf3874a14eacbc65c46"}
+
+        linked_contacts_ids : typing.Optional[int]
+            Filter by linked contacts ids
+
+        linked_deals_ids : typing.Optional[str]
+            Filter by linked Deals ids
+
+        modified_since : typing.Optional[str]
+            Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
+
+        created_since : typing.Optional[str]
+            Filter (urlencoded) the contacts created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
+
+        page : typing.Optional[int]
+            Index of the first document of the page
+
+        limit : typing.Optional[int]
+            Number of documents per page
+
+        sort : typing.Optional[GetCompaniesRequestSort]
+            Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed
+
+        sort_by : typing.Optional[str]
+            The field used to sort field names.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        GetCompaniesResponse
+            Returns companies list with filters
+
+        Examples
+        --------
+        from brevo import Brevo
+
+        client = Brevo(
+            api_key="YOUR_API_KEY",
+        )
+        client.companies.get_all_companies()
+        """
+        _response = self._raw_client.get_all_companies(
+            filters=filters,
+            linked_contacts_ids=linked_contacts_ids,
+            linked_deals_ids=linked_deals_ids,
+            modified_since=modified_since,
+            created_since=created_since,
+            page=page,
+            limit=limit,
+            sort=sort,
+            sort_by=sort_by,
+            request_options=request_options,
+        )
+        return _response.data
+
+    def create_a_company(
+        self,
+        *,
+        name: str,
+        attributes: typing.Optional[typing.Dict[str, typing.Any]] = OMIT,
+        country_code: typing.Optional[int] = OMIT,
+        linked_contacts_ids: typing.Optional[typing.Sequence[int]] = OMIT,
+        linked_deals_ids: typing.Optional[typing.Sequence[str]] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> PostCompaniesResponse:
+        """
+        Parameters
+        ----------
+        name : str
+            Name of company
+
+        attributes : typing.Optional[typing.Dict[str, typing.Any]]
+            Attributes for company creation
+
+        country_code : typing.Optional[int]
+            Country code if phone_number is passed in attributes.
+
+        linked_contacts_ids : typing.Optional[typing.Sequence[int]]
+            Contact ids to be linked with company
+
+        linked_deals_ids : typing.Optional[typing.Sequence[str]]
+            Deal ids to be linked with company
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        PostCompaniesResponse
+            Created new Company
+
+        Examples
+        --------
+        from brevo import Brevo
+
+        client = Brevo(
+            api_key="YOUR_API_KEY",
+        )
+        client.companies.create_a_company(
+            name="company",
+        )
+        """
+        _response = self._raw_client.create_a_company(
+            name=name,
+            attributes=attributes,
+            country_code=country_code,
+            linked_contacts_ids=linked_contacts_ids,
+            linked_deals_ids=linked_deals_ids,
+            request_options=request_options,
+        )
+        return _response.data
+
+    def import_companies_creation_and_updation(
+        self,
+        *,
+        file: typing.Optional[core.File] = OMIT,
+        mapping: typing.Optional[typing.Dict[str, typing.Any]] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> PostCompaniesImportResponse:
+        """
+        Import companies from a CSV file with mapping options.
+
+        Parameters
+        ----------
+        file : typing.Optional[core.File]
+            See core.File for more documentation
+
+        mapping : typing.Optional[typing.Dict[str, typing.Any]]
+            The mapping options in JSON format. Here is an example of the JSON structure: ```json {
+              "link_entities": true, // Determines whether to link related entities during the import process
+              "unlink_entities": false, // Determines whether to unlink related entities during the import process
+              "update_existing_records": true, // Determines whether to update based on company ID or treat every row as create
+              "unset_empty_attributes": false // Determines whether to unset a specific attribute during update if the values input is blank
+            } ```
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        PostCompaniesImportResponse
+            Successfully imported companies
+
+        Examples
+        --------
+        from brevo import Brevo
+
+        client = Brevo(
+            api_key="YOUR_API_KEY",
+        )
+        client.companies.import_companies_creation_and_updation()
+        """
+        _response = self._raw_client.import_companies_creation_and_updation(
+            file=file, mapping=mapping, request_options=request_options
+        )
+        return _response.data
+
+    def link_and_unlink_company_with_contact_and_deal(
+        self,
+        id: str,
+        *,
+        link_contact_ids: typing.Optional[typing.Sequence[int]] = OMIT,
+        link_deals_ids: typing.Optional[typing.Sequence[str]] = OMIT,
+        unlink_contact_ids: typing.Optional[typing.Sequence[int]] = OMIT,
+        unlink_deals_ids: typing.Optional[typing.Sequence[str]] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> None:
+        """
+        Parameters
+        ----------
+        id : str
+
+        link_contact_ids : typing.Optional[typing.Sequence[int]]
+            Contact ids for contacts to be linked with company
+
+        link_deals_ids : typing.Optional[typing.Sequence[str]]
+            Deal ids for deals to be linked with company
+
+        unlink_contact_ids : typing.Optional[typing.Sequence[int]]
+            Contact ids for contacts to be unlinked from company
+
+        unlink_deals_ids : typing.Optional[typing.Sequence[str]]
+            Deal ids for deals to be unlinked from company
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        None
+
+        Examples
+        --------
+        from brevo import Brevo
+
+        client = Brevo(
+            api_key="YOUR_API_KEY",
+        )
+        client.companies.link_and_unlink_company_with_contact_and_deal(
+            id="id",
+        )
+        """
+        _response = self._raw_client.link_and_unlink_company_with_contact_and_deal(
+            id,
+            link_contact_ids=link_contact_ids,
+            link_deals_ids=link_deals_ids,
+            unlink_contact_ids=unlink_contact_ids,
+            unlink_deals_ids=unlink_deals_ids,
+            request_options=request_options,
+        )
+        return _response.data
+
+    def get_a_company(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> Company:
+        """
+        Parameters
+        ----------
+        id : str
+            Get Company Details
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        Company
+            Returns the Company
+
+        Examples
+        --------
+        from brevo import Brevo
+
+        client = Brevo(
+            api_key="YOUR_API_KEY",
+        )
+        client.companies.get_a_company(
+            id="id",
+        )
+        """
+        _response = self._raw_client.get_a_company(id, request_options=request_options)
+        return _response.data
+
+    def delete_a_company(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> None:
+        """
+        Parameters
+        ----------
+        id : str
+            Company ID to delete
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        None
+
+        Examples
+        --------
+        from brevo import Brevo
+
+        client = Brevo(
+            api_key="YOUR_API_KEY",
+        )
+        client.companies.delete_a_company(
+            id="id",
+        )
+        """
+        _response = self._raw_client.delete_a_company(id, request_options=request_options)
+        return _response.data
+
+    def update_a_company(
+        self,
+        id: str,
+        *,
+        attributes: typing.Optional[typing.Dict[str, typing.Any]] = OMIT,
+        country_code: typing.Optional[int] = OMIT,
+        linked_contacts_ids: typing.Optional[typing.Sequence[int]] = OMIT,
+        linked_deals_ids: typing.Optional[typing.Sequence[str]] = OMIT,
+        name: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> Company:
+        """
+        Parameters
+        ----------
+        id : str
+
+        attributes : typing.Optional[typing.Dict[str, typing.Any]]
+            Attributes for company update
+
+        country_code : typing.Optional[int]
+            Country code if phone_number is passed in attributes.
+
+        linked_contacts_ids : typing.Optional[typing.Sequence[int]]
+            Warning - Using PATCH on linkedContactIds replaces the list of linked contacts. Omitted IDs will be removed.
+
+        linked_deals_ids : typing.Optional[typing.Sequence[str]]
+            Warning - Using PATCH on linkedDealsIds replaces the list of linked contacts. Omitted IDs will be removed.
+
+        name : typing.Optional[str]
+            Name of company
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        Company
+            Company updated successfully
+
+        Examples
+        --------
+        from brevo import Brevo
+
+        client = Brevo(
+            api_key="YOUR_API_KEY",
+        )
+        client.companies.update_a_company(
+            id="id",
+        )
+        """
+        _response = self._raw_client.update_a_company(
+            id,
+            attributes=attributes,
+            country_code=country_code,
+            linked_contacts_ids=linked_contacts_ids,
+            linked_deals_ids=linked_deals_ids,
+            name=name,
+            request_options=request_options,
+        )
+        return _response.data
+
+    def create_a_company_deal_attribute(
+        self,
+        *,
+        attribute_type: PostCrmAttributesRequestAttributeType,
+        label: str,
+        object_type: PostCrmAttributesRequestObjectType,
+        description: typing.Optional[str] = OMIT,
+        options_labels: typing.Optional[typing.Sequence[str]] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> PostCrmAttributesResponse:
+        """
+        Parameters
+        ----------
+        attribute_type : PostCrmAttributesRequestAttributeType
+            The type of attribute (must be one of the defined enums)
+
+        label : str
+            The label for the attribute (max 50 characters, cannot be empty)
+
+        object_type : PostCrmAttributesRequestObjectType
+            The type of object the attribute belongs to (prefilled with `companies`, mandatory)
+
+        description : typing.Optional[str]
+            A description of the attribute
+
+        options_labels : typing.Optional[typing.Sequence[str]]
+            Options for multi-choice or single-select attributes
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        PostCrmAttributesResponse
+            Created new attribute
+
+        Examples
+        --------
+        from brevo import Brevo
+
+        client = Brevo(
+            api_key="YOUR_API_KEY",
+        )
+        client.companies.create_a_company_deal_attribute(
+            attribute_type="text",
+            label="Attribute Label",
+            object_type="companies",
+        )
+        """
+        _response = self._raw_client.create_a_company_deal_attribute(
+            attribute_type=attribute_type,
+            label=label,
+            object_type=object_type,
+            description=description,
+            options_labels=options_labels,
+            request_options=request_options,
+        )
+        return _response.data
+
+    def get_company_attributes(
+        self, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> typing.List[GetCrmAttributesCompaniesResponseItem]:
+        """
+        Parameters
+        ----------
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        typing.List[GetCrmAttributesCompaniesResponseItem]
+            Returns list of company attributes
+
+        Examples
+        --------
+        from brevo import Brevo
+
+        client = Brevo(
+            api_key="YOUR_API_KEY",
+        )
+        client.companies.get_company_attributes()
+        """
+        _response = self._raw_client.get_company_attributes(request_options=request_options)
+        return _response.data
+
+
+class AsyncCompaniesClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._raw_client = AsyncRawCompaniesClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> AsyncRawCompaniesClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawCompaniesClient
+        """
+        return self._raw_client
+
+    async def get_all_companies(
+        self,
+        *,
+        filters: typing.Optional[str] = None,
+        linked_contacts_ids: typing.Optional[int] = None,
+        linked_deals_ids: typing.Optional[str] = None,
+        modified_since: typing.Optional[str] = None,
+        created_since: typing.Optional[str] = None,
+        page: typing.Optional[int] = None,
+        limit: typing.Optional[int] = None,
+        sort: typing.Optional[GetCompaniesRequestSort] = None,
+        sort_by: typing.Optional[str] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> GetCompaniesResponse:
+        """
+        Parameters
+        ----------
+        filters : typing.Optional[str]
+            Filter by attrbutes. If you have filter for owner on your side please send it as {"attributes.owner":"6299dcf3874a14eacbc65c46"}
+
+        linked_contacts_ids : typing.Optional[int]
+            Filter by linked contacts ids
+
+        linked_deals_ids : typing.Optional[str]
+            Filter by linked Deals ids
+
+        modified_since : typing.Optional[str]
+            Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
+
+        created_since : typing.Optional[str]
+            Filter (urlencoded) the contacts created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
+
+        page : typing.Optional[int]
+            Index of the first document of the page
+
+        limit : typing.Optional[int]
+            Number of documents per page
+
+        sort : typing.Optional[GetCompaniesRequestSort]
+            Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed
+
+        sort_by : typing.Optional[str]
+            The field used to sort field names.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        GetCompaniesResponse
+            Returns companies list with filters
+
+        Examples
+        --------
+        import asyncio
+
+        from brevo import AsyncBrevo
+
+        client = AsyncBrevo(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.companies.get_all_companies()
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.get_all_companies(
+            filters=filters,
+            linked_contacts_ids=linked_contacts_ids,
+            linked_deals_ids=linked_deals_ids,
+            modified_since=modified_since,
+            created_since=created_since,
+            page=page,
+            limit=limit,
+            sort=sort,
+            sort_by=sort_by,
+            request_options=request_options,
+        )
+        return _response.data
+
+    async def create_a_company(
+        self,
+        *,
+        name: str,
+        attributes: typing.Optional[typing.Dict[str, typing.Any]] = OMIT,
+        country_code: typing.Optional[int] = OMIT,
+        linked_contacts_ids: typing.Optional[typing.Sequence[int]] = OMIT,
+        linked_deals_ids: typing.Optional[typing.Sequence[str]] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> PostCompaniesResponse:
+        """
+        Parameters
+        ----------
+        name : str
+            Name of company
+
+        attributes : typing.Optional[typing.Dict[str, typing.Any]]
+            Attributes for company creation
+
+        country_code : typing.Optional[int]
+            Country code if phone_number is passed in attributes.
+
+        linked_contacts_ids : typing.Optional[typing.Sequence[int]]
+            Contact ids to be linked with company
+
+        linked_deals_ids : typing.Optional[typing.Sequence[str]]
+            Deal ids to be linked with company
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        PostCompaniesResponse
+            Created new Company
+
+        Examples
+        --------
+        import asyncio
+
+        from brevo import AsyncBrevo
+
+        client = AsyncBrevo(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.companies.create_a_company(
+                name="company",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.create_a_company(
+            name=name,
+            attributes=attributes,
+            country_code=country_code,
+            linked_contacts_ids=linked_contacts_ids,
+            linked_deals_ids=linked_deals_ids,
+            request_options=request_options,
+        )
+        return _response.data
+
+    async def import_companies_creation_and_updation(
+        self,
+        *,
+        file: typing.Optional[core.File] = OMIT,
+        mapping: typing.Optional[typing.Dict[str, typing.Any]] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> PostCompaniesImportResponse:
+        """
+        Import companies from a CSV file with mapping options.
+
+        Parameters
+        ----------
+        file : typing.Optional[core.File]
+            See core.File for more documentation
+
+        mapping : typing.Optional[typing.Dict[str, typing.Any]]
+            The mapping options in JSON format. Here is an example of the JSON structure: ```json {
+              "link_entities": true, // Determines whether to link related entities during the import process
+              "unlink_entities": false, // Determines whether to unlink related entities during the import process
+              "update_existing_records": true, // Determines whether to update based on company ID or treat every row as create
+              "unset_empty_attributes": false // Determines whether to unset a specific attribute during update if the values input is blank
+            } ```
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        PostCompaniesImportResponse
+            Successfully imported companies
+
+        Examples
+        --------
+        import asyncio
+
+        from brevo import AsyncBrevo
+
+        client = AsyncBrevo(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.companies.import_companies_creation_and_updation()
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.import_companies_creation_and_updation(
+            file=file, mapping=mapping, request_options=request_options
+        )
+        return _response.data
+
+    async def link_and_unlink_company_with_contact_and_deal(
+        self,
+        id: str,
+        *,
+        link_contact_ids: typing.Optional[typing.Sequence[int]] = OMIT,
+        link_deals_ids: typing.Optional[typing.Sequence[str]] = OMIT,
+        unlink_contact_ids: typing.Optional[typing.Sequence[int]] = OMIT,
+        unlink_deals_ids: typing.Optional[typing.Sequence[str]] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> None:
+        """
+        Parameters
+        ----------
+        id : str
+
+        link_contact_ids : typing.Optional[typing.Sequence[int]]
+            Contact ids for contacts to be linked with company
+
+        link_deals_ids : typing.Optional[typing.Sequence[str]]
+            Deal ids for deals to be linked with company
+
+        unlink_contact_ids : typing.Optional[typing.Sequence[int]]
+            Contact ids for contacts to be unlinked from company
+
+        unlink_deals_ids : typing.Optional[typing.Sequence[str]]
+            Deal ids for deals to be unlinked from company
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        None
+
+        Examples
+        --------
+        import asyncio
+
+        from brevo import AsyncBrevo
+
+        client = AsyncBrevo(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.companies.link_and_unlink_company_with_contact_and_deal(
+                id="id",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.link_and_unlink_company_with_contact_and_deal(
+            id,
+            link_contact_ids=link_contact_ids,
+            link_deals_ids=link_deals_ids,
+            unlink_contact_ids=unlink_contact_ids,
+            unlink_deals_ids=unlink_deals_ids,
+            request_options=request_options,
+        )
+        return _response.data
+
+    async def get_a_company(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> Company:
+        """
+        Parameters
+        ----------
+        id : str
+            Get Company Details
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        Company
+            Returns the Company
+
+        Examples
+        --------
+        import asyncio
+
+        from brevo import AsyncBrevo
+
+        client = AsyncBrevo(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.companies.get_a_company(
+                id="id",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.get_a_company(id, request_options=request_options)
+        return _response.data
+
+    async def delete_a_company(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> None:
+        """
+        Parameters
+        ----------
+        id : str
+            Company ID to delete
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        None
+
+        Examples
+        --------
+        import asyncio
+
+        from brevo import AsyncBrevo
+
+        client = AsyncBrevo(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.companies.delete_a_company(
+                id="id",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.delete_a_company(id, request_options=request_options)
+        return _response.data
+
+    async def update_a_company(
+        self,
+        id: str,
+        *,
+        attributes: typing.Optional[typing.Dict[str, typing.Any]] = OMIT,
+        country_code: typing.Optional[int] = OMIT,
+        linked_contacts_ids: typing.Optional[typing.Sequence[int]] = OMIT,
+        linked_deals_ids: typing.Optional[typing.Sequence[str]] = OMIT,
+        name: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> Company:
+        """
+        Parameters
+        ----------
+        id : str
+
+        attributes : typing.Optional[typing.Dict[str, typing.Any]]
+            Attributes for company update
+
+        country_code : typing.Optional[int]
+            Country code if phone_number is passed in attributes.
+
+        linked_contacts_ids : typing.Optional[typing.Sequence[int]]
+            Warning - Using PATCH on linkedContactIds replaces the list of linked contacts. Omitted IDs will be removed.
+
+        linked_deals_ids : typing.Optional[typing.Sequence[str]]
+            Warning - Using PATCH on linkedDealsIds replaces the list of linked contacts. Omitted IDs will be removed.
+
+        name : typing.Optional[str]
+            Name of company
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        Company
+            Company updated successfully
+
+        Examples
+        --------
+        import asyncio
+
+        from brevo import AsyncBrevo
+
+        client = AsyncBrevo(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.companies.update_a_company(
+                id="id",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.update_a_company(
+            id,
+            attributes=attributes,
+            country_code=country_code,
+            linked_contacts_ids=linked_contacts_ids,
+            linked_deals_ids=linked_deals_ids,
+            name=name,
+            request_options=request_options,
+        )
+        return _response.data
+
+    async def create_a_company_deal_attribute(
+        self,
+        *,
+        attribute_type: PostCrmAttributesRequestAttributeType,
+        label: str,
+        object_type: PostCrmAttributesRequestObjectType,
+        description: typing.Optional[str] = OMIT,
+        options_labels: typing.Optional[typing.Sequence[str]] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> PostCrmAttributesResponse:
+        """
+        Parameters
+        ----------
+        attribute_type : PostCrmAttributesRequestAttributeType
+            The type of attribute (must be one of the defined enums)
+
+        label : str
+            The label for the attribute (max 50 characters, cannot be empty)
+
+        object_type : PostCrmAttributesRequestObjectType
+            The type of object the attribute belongs to (prefilled with `companies`, mandatory)
+
+        description : typing.Optional[str]
+            A description of the attribute
+
+        options_labels : typing.Optional[typing.Sequence[str]]
+            Options for multi-choice or single-select attributes
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        PostCrmAttributesResponse
+            Created new attribute
+
+        Examples
+        --------
+        import asyncio
+
+        from brevo import AsyncBrevo
+
+        client = AsyncBrevo(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.companies.create_a_company_deal_attribute(
+                attribute_type="text",
+                label="Attribute Label",
+                object_type="companies",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.create_a_company_deal_attribute(
+            attribute_type=attribute_type,
+            label=label,
+            object_type=object_type,
+            description=description,
+            options_labels=options_labels,
+            request_options=request_options,
+        )
+        return _response.data
+
+    async def get_company_attributes(
+        self, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> typing.List[GetCrmAttributesCompaniesResponseItem]:
+        """
+        Parameters
+        ----------
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        typing.List[GetCrmAttributesCompaniesResponseItem]
+            Returns list of company attributes
+
+        Examples
+        --------
+        import asyncio
+
+        from brevo import AsyncBrevo
+
+        client = AsyncBrevo(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.companies.get_company_attributes()
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.get_company_attributes(request_options=request_options)
+        return _response.data