mergepythonclient 0.0.1__py3-none-any.whl

merge/resources/hris/groups.py

@@ -0,0 +1,304 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from __future__ import annotations
+
+from typing import 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 Group, group_list_params, group_retrieve_params
+from ..._base_client import AsyncPaginator, make_request_options
+
+__all__ = ["Groups", "AsyncGroups"]
+
+
+class Groups(SyncAPIResource):
+    def retrieve(
+        self,
+        id: str,
+        *,
+        include_remote_data: bool | NotGiven = NOT_GIVEN,
+        remote_fields: Literal["type"] | NotGiven = NOT_GIVEN,
+        show_enum_origins: Literal["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,
+    ) -> Group:
+        """
+        Returns a `Group` object with the given `id`.
+
+        Args:
+          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/groups/{id}",
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform(
+                    {
+                        "include_remote_data": include_remote_data,
+                        "remote_fields": remote_fields,
+                        "show_enum_origins": show_enum_origins,
+                    },
+                    group_retrieve_params.GroupRetrieveParams,
+                ),
+            ),
+            cast_to=Group,
+        )
+
+    def list(
+        self,
+        *,
+        created_after: Union[str, datetime] | NotGiven = NOT_GIVEN,
+        created_before: Union[str, datetime] | NotGiven = NOT_GIVEN,
+        cursor: str | 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_fields: Literal["type"] | NotGiven = NOT_GIVEN,
+        remote_id: Optional[str] | NotGiven = NOT_GIVEN,
+        show_enum_origins: Literal["type"] | NotGiven = NOT_GIVEN,
+        types: 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[Group]:
+        """
+        Returns a list of `Group` 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.
+
+          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_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.
+
+          types: If provided, will only return groups of these types. Multiple values can be
+              separated by commas.
+
+          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/groups",
+            page=SyncPage[Group],
+            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,
+                        "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_fields": remote_fields,
+                        "remote_id": remote_id,
+                        "show_enum_origins": show_enum_origins,
+                        "types": types,
+                    },
+                    group_list_params.GroupListParams,
+                ),
+            ),
+            model=Group,
+        )
+
+
+class AsyncGroups(AsyncAPIResource):
+    async def retrieve(
+        self,
+        id: str,
+        *,
+        include_remote_data: bool | NotGiven = NOT_GIVEN,
+        remote_fields: Literal["type"] | NotGiven = NOT_GIVEN,
+        show_enum_origins: Literal["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,
+    ) -> Group:
+        """
+        Returns a `Group` object with the given `id`.
+
+        Args:
+          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/groups/{id}",
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform(
+                    {
+                        "include_remote_data": include_remote_data,
+                        "remote_fields": remote_fields,
+                        "show_enum_origins": show_enum_origins,
+                    },
+                    group_retrieve_params.GroupRetrieveParams,
+                ),
+            ),
+            cast_to=Group,
+        )
+
+    def list(
+        self,
+        *,
+        created_after: Union[str, datetime] | NotGiven = NOT_GIVEN,
+        created_before: Union[str, datetime] | NotGiven = NOT_GIVEN,
+        cursor: str | 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_fields: Literal["type"] | NotGiven = NOT_GIVEN,
+        remote_id: Optional[str] | NotGiven = NOT_GIVEN,
+        show_enum_origins: Literal["type"] | NotGiven = NOT_GIVEN,
+        types: 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[Group, AsyncPage[Group]]:
+        """
+        Returns a list of `Group` 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.
+
+          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_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.
+
+          types: If provided, will only return groups of these types. Multiple values can be
+              separated by commas.
+
+          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/groups",
+            page=AsyncPage[Group],
+            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,
+                        "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_fields": remote_fields,
+                        "remote_id": remote_id,
+                        "show_enum_origins": show_enum_origins,
+                        "types": types,
+                    },
+                    group_list_params.GroupListParams,
+                ),
+            ),
+            model=Group,
+        )

merge/resources/hris/hris.py

@@ -0,0 +1,149 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from .banks import Banks, AsyncBanks
+from .teams import Teams, AsyncTeams
+from .groups import Groups, AsyncGroups
+from .issues import Issues, AsyncIssues
+from .benefits import Benefits, AsyncBenefits
+from .time_off import TimeOffResource, AsyncTimeOffResource
+from .companies import Companies, AsyncCompanies
+from .employees import Employees, AsyncEmployees
+from .locations import Locations, AsyncLocations
+from .pay_groups import PayGroups, AsyncPayGroups
+from ..._resource import SyncAPIResource, AsyncAPIResource
+from .employments import Employments, AsyncEmployments
+from .link_tokens import LinkTokens, AsyncLinkTokens
+from .remote_keys import RemoteKeys, AsyncRemoteKeys
+from .sync_status import SyncStatus, AsyncSyncStatus
+from .payroll_runs import PayrollRuns, AsyncPayrollRuns
+from .account_tokens import AccountTokens, AsyncAccountTokens
+from .selective_sync import SelectiveSync, AsyncSelectiveSync
+from .account_details import AccountDetails, AsyncAccountDetails
+from .linked_accounts import LinkedAccounts, AsyncLinkedAccounts
+from .available_actions import AvailableActions, AsyncAvailableActions
+from .time_off_balances import TimeOffBalances, AsyncTimeOffBalances
+from .webhook_receivers import WebhookReceivers, AsyncWebhookReceivers
+from .common_model_scopes import CommonModelScopes, AsyncCommonModelScopes
+from .passthrough_requests import PassthroughRequests, AsyncPassthroughRequests
+from .employee_payroll_runs import EmployeePayrollRuns, AsyncEmployeePayrollRuns
+
+if TYPE_CHECKING:
+    from ..._client import Merge, AsyncMerge
+
+__all__ = ["HRIS", "AsyncHRIS"]
+
+
+class HRIS(SyncAPIResource):
+    banks: Banks
+    benefits: Benefits
+    companies: Companies
+    employee_payroll_runs: EmployeePayrollRuns
+    employees: Employees
+    employments: Employments
+    groups: Groups
+    locations: Locations
+    pay_groups: PayGroups
+    payroll_runs: PayrollRuns
+    teams: Teams
+    time_off: TimeOffResource
+    time_off_balances: TimeOffBalances
+    account_details: AccountDetails
+    account_tokens: AccountTokens
+    link_tokens: LinkTokens
+    available_actions: AvailableActions
+    remote_keys: RemoteKeys
+    issues: Issues
+    common_model_scopes: CommonModelScopes
+    passthrough_requests: PassthroughRequests
+    sync_status: SyncStatus
+    webhook_receivers: WebhookReceivers
+    linked_accounts: LinkedAccounts
+    selective_sync: SelectiveSync
+
+    def __init__(self, client: Merge) -> None:
+        super().__init__(client)
+        self.banks = Banks(client)
+        self.benefits = Benefits(client)
+        self.companies = Companies(client)
+        self.employee_payroll_runs = EmployeePayrollRuns(client)
+        self.employees = Employees(client)
+        self.employments = Employments(client)
+        self.groups = Groups(client)
+        self.locations = Locations(client)
+        self.pay_groups = PayGroups(client)
+        self.payroll_runs = PayrollRuns(client)
+        self.teams = Teams(client)
+        self.time_off = TimeOffResource(client)
+        self.time_off_balances = TimeOffBalances(client)
+        self.account_details = AccountDetails(client)
+        self.account_tokens = AccountTokens(client)
+        self.link_tokens = LinkTokens(client)
+        self.available_actions = AvailableActions(client)
+        self.remote_keys = RemoteKeys(client)
+        self.issues = Issues(client)
+        self.common_model_scopes = CommonModelScopes(client)
+        self.passthrough_requests = PassthroughRequests(client)
+        self.sync_status = SyncStatus(client)
+        self.webhook_receivers = WebhookReceivers(client)
+        self.linked_accounts = LinkedAccounts(client)
+        self.selective_sync = SelectiveSync(client)
+
+
+class AsyncHRIS(AsyncAPIResource):
+    banks: AsyncBanks
+    benefits: AsyncBenefits
+    companies: AsyncCompanies
+    employee_payroll_runs: AsyncEmployeePayrollRuns
+    employees: AsyncEmployees
+    employments: AsyncEmployments
+    groups: AsyncGroups
+    locations: AsyncLocations
+    pay_groups: AsyncPayGroups
+    payroll_runs: AsyncPayrollRuns
+    teams: AsyncTeams
+    time_off: AsyncTimeOffResource
+    time_off_balances: AsyncTimeOffBalances
+    account_details: AsyncAccountDetails
+    account_tokens: AsyncAccountTokens
+    link_tokens: AsyncLinkTokens
+    available_actions: AsyncAvailableActions
+    remote_keys: AsyncRemoteKeys
+    issues: AsyncIssues
+    common_model_scopes: AsyncCommonModelScopes
+    passthrough_requests: AsyncPassthroughRequests
+    sync_status: AsyncSyncStatus
+    webhook_receivers: AsyncWebhookReceivers
+    linked_accounts: AsyncLinkedAccounts
+    selective_sync: AsyncSelectiveSync
+
+    def __init__(self, client: AsyncMerge) -> None:
+        super().__init__(client)
+        self.banks = AsyncBanks(client)
+        self.benefits = AsyncBenefits(client)
+        self.companies = AsyncCompanies(client)
+        self.employee_payroll_runs = AsyncEmployeePayrollRuns(client)
+        self.employees = AsyncEmployees(client)
+        self.employments = AsyncEmployments(client)
+        self.groups = AsyncGroups(client)
+        self.locations = AsyncLocations(client)
+        self.pay_groups = AsyncPayGroups(client)
+        self.payroll_runs = AsyncPayrollRuns(client)
+        self.teams = AsyncTeams(client)
+        self.time_off = AsyncTimeOffResource(client)
+        self.time_off_balances = AsyncTimeOffBalances(client)
+        self.account_details = AsyncAccountDetails(client)
+        self.account_tokens = AsyncAccountTokens(client)
+        self.link_tokens = AsyncLinkTokens(client)
+        self.available_actions = AsyncAvailableActions(client)
+        self.remote_keys = AsyncRemoteKeys(client)
+        self.issues = AsyncIssues(client)
+        self.common_model_scopes = AsyncCommonModelScopes(client)
+        self.passthrough_requests = AsyncPassthroughRequests(client)
+        self.sync_status = AsyncSyncStatus(client)
+        self.webhook_receivers = AsyncWebhookReceivers(client)
+        self.linked_accounts = AsyncLinkedAccounts(client)
+        self.selective_sync = AsyncSelectiveSync(client)