mergepythonclient 0.0.1__py3-none-any.whl

merge/resources/hris/banks.py

@@ -0,0 +1,356 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from __future__ import annotations
+
+from typing import List, Union, Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from ..._types import NOT_GIVEN, Body, Query, Headers, NotGiven
+from ..._utils import maybe_transform
+from ..._resource import SyncAPIResource, AsyncAPIResource
+from ...pagination import SyncPage, AsyncPage
+from ...types.hris import BankInfo, bank_list_params, bank_retrieve_params
+from ..._base_client import AsyncPaginator, make_request_options
+
+__all__ = ["Banks", "AsyncBanks"]
+
+
+class Banks(SyncAPIResource):
+    def retrieve(
+        self,
+        id: str,
+        *,
+        expand: List[Literal["employee"]] | NotGiven = NOT_GIVEN,
+        include_remote_data: bool | NotGiven = NOT_GIVEN,
+        remote_fields: Literal["account_type"] | NotGiven = NOT_GIVEN,
+        show_enum_origins: Literal["account_type"] | 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.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | None | NotGiven = NOT_GIVEN,
+    ) -> BankInfo:
+        """
+        Returns a `BankInfo` object with the given `id`.
+
+        Args:
+          expand: Which relations should be returned in expanded form. Multiple relation names
+              should be comma separated without spaces.
+
+          include_remote_data: Whether to include the original data Merge fetched from the third-party to
+              produce these models.
+
+          remote_fields: Deprecated. Use show_enum_origins.
+
+          show_enum_origins: Which fields should be returned in non-normalized form.
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        return self._get(
+            f"/hris/v1/bank-info/{id}",
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform(
+                    {
+                        "expand": expand,
+                        "include_remote_data": include_remote_data,
+                        "remote_fields": remote_fields,
+                        "show_enum_origins": show_enum_origins,
+                    },
+                    bank_retrieve_params.BankRetrieveParams,
+                ),
+            ),
+            cast_to=BankInfo,
+        )
+
+    def list(
+        self,
+        *,
+        account_type: Optional[Literal["CHECKING", "SAVINGS"]] | NotGiven = NOT_GIVEN,
+        bank_name: Optional[str] | NotGiven = NOT_GIVEN,
+        created_after: Union[str, datetime] | NotGiven = NOT_GIVEN,
+        created_before: Union[str, datetime] | NotGiven = NOT_GIVEN,
+        cursor: str | NotGiven = NOT_GIVEN,
+        employee_id: str | NotGiven = NOT_GIVEN,
+        expand: List[Literal["employee"]] | NotGiven = NOT_GIVEN,
+        include_deleted_data: bool | NotGiven = NOT_GIVEN,
+        include_remote_data: bool | NotGiven = NOT_GIVEN,
+        modified_after: Union[str, datetime] | NotGiven = NOT_GIVEN,
+        modified_before: Union[str, datetime] | NotGiven = NOT_GIVEN,
+        order_by: Literal["-remote_created_at", "remote_created_at"] | NotGiven = NOT_GIVEN,
+        page_size: int | NotGiven = NOT_GIVEN,
+        remote_fields: Literal["account_type"] | NotGiven = NOT_GIVEN,
+        remote_id: Optional[str] | NotGiven = NOT_GIVEN,
+        show_enum_origins: Literal["account_type"] | 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.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | None | NotGiven = NOT_GIVEN,
+    ) -> SyncPage[BankInfo]:
+        """
+        Returns a list of `BankInfo` objects.
+
+        Args:
+          account_type:
+              If provided, will only return BankInfo's with this account type. Options:
+              ('SAVINGS', 'CHECKING')
+
+              - `SAVINGS` - SAVINGS
+              - `CHECKING` - CHECKING
+
+          bank_name: If provided, will only return BankInfo's with this bank name.
+
+          created_after: If provided, will only return objects created after this datetime.
+
+          created_before: If provided, will only return objects created before this datetime.
+
+          cursor: The pagination cursor value.
+
+          employee_id: If provided, will only return bank accounts for this employee.
+
+          expand: Which relations should be returned in expanded form. Multiple relation names
+              should be comma separated without spaces.
+
+          include_deleted_data: Whether to include data that was marked as deleted by third party webhooks.
+
+          include_remote_data: Whether to include the original data Merge fetched from the third-party to
+              produce these models.
+
+          modified_after: If provided, only objects synced by Merge after this date time will be returned.
+
+          modified_before: If provided, only objects synced by Merge before this date time will be
+              returned.
+
+          order_by: Overrides the default ordering for this endpoint.
+
+          page_size: Number of results to return per page.
+
+          remote_fields: Deprecated. Use show_enum_origins.
+
+          remote_id: The API provider's ID for the given object.
+
+          show_enum_origins: Which fields should be returned in non-normalized form.
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        return self._get_api_list(
+            "/hris/v1/bank-info",
+            page=SyncPage[BankInfo],
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform(
+                    {
+                        "account_type": account_type,
+                        "bank_name": bank_name,
+                        "created_after": created_after,
+                        "created_before": created_before,
+                        "cursor": cursor,
+                        "employee_id": employee_id,
+                        "expand": expand,
+                        "include_deleted_data": include_deleted_data,
+                        "include_remote_data": include_remote_data,
+                        "modified_after": modified_after,
+                        "modified_before": modified_before,
+                        "order_by": order_by,
+                        "page_size": page_size,
+                        "remote_fields": remote_fields,
+                        "remote_id": remote_id,
+                        "show_enum_origins": show_enum_origins,
+                    },
+                    bank_list_params.BankListParams,
+                ),
+            ),
+            model=BankInfo,
+        )
+
+
+class AsyncBanks(AsyncAPIResource):
+    async def retrieve(
+        self,
+        id: str,
+        *,
+        expand: List[Literal["employee"]] | NotGiven = NOT_GIVEN,
+        include_remote_data: bool | NotGiven = NOT_GIVEN,
+        remote_fields: Literal["account_type"] | NotGiven = NOT_GIVEN,
+        show_enum_origins: Literal["account_type"] | 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.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | None | NotGiven = NOT_GIVEN,
+    ) -> BankInfo:
+        """
+        Returns a `BankInfo` object with the given `id`.
+
+        Args:
+          expand: Which relations should be returned in expanded form. Multiple relation names
+              should be comma separated without spaces.
+
+          include_remote_data: Whether to include the original data Merge fetched from the third-party to
+              produce these models.
+
+          remote_fields: Deprecated. Use show_enum_origins.
+
+          show_enum_origins: Which fields should be returned in non-normalized form.
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        return await self._get(
+            f"/hris/v1/bank-info/{id}",
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform(
+                    {
+                        "expand": expand,
+                        "include_remote_data": include_remote_data,
+                        "remote_fields": remote_fields,
+                        "show_enum_origins": show_enum_origins,
+                    },
+                    bank_retrieve_params.BankRetrieveParams,
+                ),
+            ),
+            cast_to=BankInfo,
+        )
+
+    def list(
+        self,
+        *,
+        account_type: Optional[Literal["CHECKING", "SAVINGS"]] | NotGiven = NOT_GIVEN,
+        bank_name: Optional[str] | NotGiven = NOT_GIVEN,
+        created_after: Union[str, datetime] | NotGiven = NOT_GIVEN,
+        created_before: Union[str, datetime] | NotGiven = NOT_GIVEN,
+        cursor: str | NotGiven = NOT_GIVEN,
+        employee_id: str | NotGiven = NOT_GIVEN,
+        expand: List[Literal["employee"]] | NotGiven = NOT_GIVEN,
+        include_deleted_data: bool | NotGiven = NOT_GIVEN,
+        include_remote_data: bool | NotGiven = NOT_GIVEN,
+        modified_after: Union[str, datetime] | NotGiven = NOT_GIVEN,
+        modified_before: Union[str, datetime] | NotGiven = NOT_GIVEN,
+        order_by: Literal["-remote_created_at", "remote_created_at"] | NotGiven = NOT_GIVEN,
+        page_size: int | NotGiven = NOT_GIVEN,
+        remote_fields: Literal["account_type"] | NotGiven = NOT_GIVEN,
+        remote_id: Optional[str] | NotGiven = NOT_GIVEN,
+        show_enum_origins: Literal["account_type"] | 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.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | None | NotGiven = NOT_GIVEN,
+    ) -> AsyncPaginator[BankInfo, AsyncPage[BankInfo]]:
+        """
+        Returns a list of `BankInfo` objects.
+
+        Args:
+          account_type:
+              If provided, will only return BankInfo's with this account type. Options:
+              ('SAVINGS', 'CHECKING')
+
+              - `SAVINGS` - SAVINGS
+              - `CHECKING` - CHECKING
+
+          bank_name: If provided, will only return BankInfo's with this bank name.
+
+          created_after: If provided, will only return objects created after this datetime.
+
+          created_before: If provided, will only return objects created before this datetime.
+
+          cursor: The pagination cursor value.
+
+          employee_id: If provided, will only return bank accounts for this employee.
+
+          expand: Which relations should be returned in expanded form. Multiple relation names
+              should be comma separated without spaces.
+
+          include_deleted_data: Whether to include data that was marked as deleted by third party webhooks.
+
+          include_remote_data: Whether to include the original data Merge fetched from the third-party to
+              produce these models.
+
+          modified_after: If provided, only objects synced by Merge after this date time will be returned.
+
+          modified_before: If provided, only objects synced by Merge before this date time will be
+              returned.
+
+          order_by: Overrides the default ordering for this endpoint.
+
+          page_size: Number of results to return per page.
+
+          remote_fields: Deprecated. Use show_enum_origins.
+
+          remote_id: The API provider's ID for the given object.
+
+          show_enum_origins: Which fields should be returned in non-normalized form.
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        return self._get_api_list(
+            "/hris/v1/bank-info",
+            page=AsyncPage[BankInfo],
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform(
+                    {
+                        "account_type": account_type,
+                        "bank_name": bank_name,
+                        "created_after": created_after,
+                        "created_before": created_before,
+                        "cursor": cursor,
+                        "employee_id": employee_id,
+                        "expand": expand,
+                        "include_deleted_data": include_deleted_data,
+                        "include_remote_data": include_remote_data,
+                        "modified_after": modified_after,
+                        "modified_before": modified_before,
+                        "order_by": order_by,
+                        "page_size": page_size,
+                        "remote_fields": remote_fields,
+                        "remote_id": remote_id,
+                        "show_enum_origins": show_enum_origins,
+                    },
+                    bank_list_params.BankListParams,
+                ),
+            ),
+            model=BankInfo,
+        )

merge/resources/hris/benefits.py

@@ -0,0 +1,290 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from __future__ import annotations
+
+from typing import List, Union, Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from ..._types import NOT_GIVEN, Body, Query, Headers, NotGiven
+from ..._utils import maybe_transform
+from ..._resource import SyncAPIResource, AsyncAPIResource
+from ...pagination import SyncPage, AsyncPage
+from ...types.hris import Benefit, benefit_list_params, benefit_retrieve_params
+from ..._base_client import AsyncPaginator, make_request_options
+
+__all__ = ["Benefits", "AsyncBenefits"]
+
+
+class Benefits(SyncAPIResource):
+    def retrieve(
+        self,
+        id: str,
+        *,
+        expand: List[Literal["employee"]] | NotGiven = NOT_GIVEN,
+        include_remote_data: bool | 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.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | None | NotGiven = NOT_GIVEN,
+    ) -> Benefit:
+        """
+        Returns a `Benefit` object with the given `id`.
+
+        Args:
+          expand: Which relations should be returned in expanded form. Multiple relation names
+              should be comma separated without spaces.
+
+          include_remote_data: Whether to include the original data Merge fetched from the third-party to
+              produce these models.
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        return self._get(
+            f"/hris/v1/benefits/{id}",
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform(
+                    {
+                        "expand": expand,
+                        "include_remote_data": include_remote_data,
+                    },
+                    benefit_retrieve_params.BenefitRetrieveParams,
+                ),
+            ),
+            cast_to=Benefit,
+        )
+
+    def list(
+        self,
+        *,
+        created_after: Union[str, datetime] | NotGiven = NOT_GIVEN,
+        created_before: Union[str, datetime] | NotGiven = NOT_GIVEN,
+        cursor: str | NotGiven = NOT_GIVEN,
+        employee_id: str | NotGiven = NOT_GIVEN,
+        expand: List[Literal["employee"]] | NotGiven = NOT_GIVEN,
+        include_deleted_data: bool | NotGiven = NOT_GIVEN,
+        include_remote_data: bool | NotGiven = NOT_GIVEN,
+        modified_after: Union[str, datetime] | NotGiven = NOT_GIVEN,
+        modified_before: Union[str, datetime] | NotGiven = NOT_GIVEN,
+        page_size: int | NotGiven = NOT_GIVEN,
+        remote_id: 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.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | None | NotGiven = NOT_GIVEN,
+    ) -> SyncPage[Benefit]:
+        """
+        Returns a list of `Benefit` objects.
+
+        Args:
+          created_after: If provided, will only return objects created after this datetime.
+
+          created_before: If provided, will only return objects created before this datetime.
+
+          cursor: The pagination cursor value.
+
+          employee_id: If provided, will return the benefits associated with the employee.
+
+          expand: Which relations should be returned in expanded form. Multiple relation names
+              should be comma separated without spaces.
+
+          include_deleted_data: Whether to include data that was marked as deleted by third party webhooks.
+
+          include_remote_data: Whether to include the original data Merge fetched from the third-party to
+              produce these models.
+
+          modified_after: If provided, only objects synced by Merge after this date time will be returned.
+
+          modified_before: If provided, only objects synced by Merge before this date time will be
+              returned.
+
+          page_size: Number of results to return per page.
+
+          remote_id: The API provider's ID for the given object.
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        return self._get_api_list(
+            "/hris/v1/benefits",
+            page=SyncPage[Benefit],
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform(
+                    {
+                        "created_after": created_after,
+                        "created_before": created_before,
+                        "cursor": cursor,
+                        "employee_id": employee_id,
+                        "expand": expand,
+                        "include_deleted_data": include_deleted_data,
+                        "include_remote_data": include_remote_data,
+                        "modified_after": modified_after,
+                        "modified_before": modified_before,
+                        "page_size": page_size,
+                        "remote_id": remote_id,
+                    },
+                    benefit_list_params.BenefitListParams,
+                ),
+            ),
+            model=Benefit,
+        )
+
+
+class AsyncBenefits(AsyncAPIResource):
+    async def retrieve(
+        self,
+        id: str,
+        *,
+        expand: List[Literal["employee"]] | NotGiven = NOT_GIVEN,
+        include_remote_data: bool | 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.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | None | NotGiven = NOT_GIVEN,
+    ) -> Benefit:
+        """
+        Returns a `Benefit` object with the given `id`.
+
+        Args:
+          expand: Which relations should be returned in expanded form. Multiple relation names
+              should be comma separated without spaces.
+
+          include_remote_data: Whether to include the original data Merge fetched from the third-party to
+              produce these models.
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        return await self._get(
+            f"/hris/v1/benefits/{id}",
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform(
+                    {
+                        "expand": expand,
+                        "include_remote_data": include_remote_data,
+                    },
+                    benefit_retrieve_params.BenefitRetrieveParams,
+                ),
+            ),
+            cast_to=Benefit,
+        )
+
+    def list(
+        self,
+        *,
+        created_after: Union[str, datetime] | NotGiven = NOT_GIVEN,
+        created_before: Union[str, datetime] | NotGiven = NOT_GIVEN,
+        cursor: str | NotGiven = NOT_GIVEN,
+        employee_id: str | NotGiven = NOT_GIVEN,
+        expand: List[Literal["employee"]] | NotGiven = NOT_GIVEN,
+        include_deleted_data: bool | NotGiven = NOT_GIVEN,
+        include_remote_data: bool | NotGiven = NOT_GIVEN,
+        modified_after: Union[str, datetime] | NotGiven = NOT_GIVEN,
+        modified_before: Union[str, datetime] | NotGiven = NOT_GIVEN,
+        page_size: int | NotGiven = NOT_GIVEN,
+        remote_id: 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.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | None | NotGiven = NOT_GIVEN,
+    ) -> AsyncPaginator[Benefit, AsyncPage[Benefit]]:
+        """
+        Returns a list of `Benefit` objects.
+
+        Args:
+          created_after: If provided, will only return objects created after this datetime.
+
+          created_before: If provided, will only return objects created before this datetime.
+
+          cursor: The pagination cursor value.
+
+          employee_id: If provided, will return the benefits associated with the employee.
+
+          expand: Which relations should be returned in expanded form. Multiple relation names
+              should be comma separated without spaces.
+
+          include_deleted_data: Whether to include data that was marked as deleted by third party webhooks.
+
+          include_remote_data: Whether to include the original data Merge fetched from the third-party to
+              produce these models.
+
+          modified_after: If provided, only objects synced by Merge after this date time will be returned.
+
+          modified_before: If provided, only objects synced by Merge before this date time will be
+              returned.
+
+          page_size: Number of results to return per page.
+
+          remote_id: The API provider's ID for the given object.
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        return self._get_api_list(
+            "/hris/v1/benefits",
+            page=AsyncPage[Benefit],
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform(
+                    {
+                        "created_after": created_after,
+                        "created_before": created_before,
+                        "cursor": cursor,
+                        "employee_id": employee_id,
+                        "expand": expand,
+                        "include_deleted_data": include_deleted_data,
+                        "include_remote_data": include_remote_data,
+                        "modified_after": modified_after,
+                        "modified_before": modified_before,
+                        "page_size": page_size,
+                        "remote_id": remote_id,
+                    },
+                    benefit_list_params.BenefitListParams,
+                ),
+            ),
+            model=Benefit,
+        )