fix(client): fix PayStatementResponse body

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 46
 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch%2Ffinch-1a82d3230c420c8562600b0ad45133d79ab68ffd21d524ab26eef11e163dba09.yml
 openapi_spec_hash: 7bd02ce73505e51c5fd78608fed55c62
-config_hash: 81eb5297df860cf29f8c5bdbf9f89608
+config_hash: bb896000dc7e790e5c9ddda2549fb7ac

api.md

@@ -128,7 +128,12 @@ Methods:
 Types:
 
 ```python
-from finch.types.hris import PayStatementResponse, PayStatementResponseBody
+from finch.types.hris import (
+    PayStatement,
+    PayStatementDataSyncInProgress,
+    PayStatementResponse,
+    PayStatementResponseBody,
+)
 ```
 
 Methods:

src/finch/resources/sandbox/payment.py

@@ -14,6 +14,7 @@
 from ..._response import to_streamed_response_wrapper, async_to_streamed_response_wrapper
 from ..._base_client import make_request_options
 from ...types.sandbox import payment_create_params
+from ...types.hris.pay_statement_param import PayStatementParam
 from ...types.sandbox.payment_create_response import PaymentCreateResponse
 
 __all__ = ["Payment", "AsyncPayment"]
@@ -43,7 +44,7 @@ def create(
         self,
         *,
         end_date: str | NotGiven = NOT_GIVEN,
-        pay_statements: Iterable[payment_create_params.PayStatement] | NotGiven = NOT_GIVEN,
+        pay_statements: Iterable[PayStatementParam] | NotGiven = NOT_GIVEN,
         start_date: 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.
@@ -105,7 +106,7 @@ async def create(
         self,
         *,
         end_date: str | NotGiven = NOT_GIVEN,
-        pay_statements: Iterable[payment_create_params.PayStatement] | NotGiven = NOT_GIVEN,
+        pay_statements: Iterable[PayStatementParam] | NotGiven = NOT_GIVEN,
         start_date: 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.

src/finch/types/hris/__init__.py

@@ -8,13 +8,15 @@
 from .payment import Payment as Payment
 from .individual import Individual as Individual
 from .benefit_type import BenefitType as BenefitType
+from .pay_statement import PayStatement as PayStatement
 from .company_benefit import CompanyBenefit as CompanyBenefit
 from .employment_data import EmploymentData as EmploymentData
 from .benefits_support import BenefitsSupport as BenefitsSupport
 from .benefit_frequency import BenefitFrequency as BenefitFrequency
 from .document_response import DocumentResponse as DocumentResponse
 from .benfit_contribution import BenfitContribution as BenfitContribution
 from .individual_response import IndividualResponse as IndividualResponse
+from .pay_statement_param import PayStatementParam as PayStatementParam
 from .payment_list_params import PaymentListParams as PaymentListParams
 from .benefit_contribution import BenefitContribution as BenefitContribution
 from .document_list_params import DocumentListParams as DocumentListParams
@@ -35,6 +37,7 @@
 from .create_company_benefits_response import CreateCompanyBenefitsResponse as CreateCompanyBenefitsResponse
 from .directory_list_individuals_params import DirectoryListIndividualsParams as DirectoryListIndividualsParams
 from .pay_statement_retrieve_many_params import PayStatementRetrieveManyParams as PayStatementRetrieveManyParams
+from .pay_statement_data_sync_in_progress import PayStatementDataSyncInProgress as PayStatementDataSyncInProgress
 from .benefit_list_supported_benefits_response import (
     BenefitListSupportedBenefitsResponse as BenefitListSupportedBenefitsResponse,
 )

src/finch/types/hris/pay_statement.py

@@ -0,0 +1,198 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict, List, Optional
+from typing_extensions import Literal
+
+from ..money import Money
+from ..._models import BaseModel
+from .benefit_type import BenefitType
+
+__all__ = [
+    "PayStatement",
+    "Earning",
+    "EarningAttributes",
+    "EarningAttributesMetadata",
+    "EmployeeDeduction",
+    "EmployeeDeductionAttributes",
+    "EmployeeDeductionAttributesMetadata",
+    "EmployerContribution",
+    "EmployerContributionAttributes",
+    "EmployerContributionAttributesMetadata",
+    "Tax",
+    "TaxAttributes",
+    "TaxAttributesMetadata",
+]
+
+
+class EarningAttributesMetadata(BaseModel):
+    metadata: Dict[str, Optional[object]]
+    """The metadata to be attached to the entity by existing rules.
+
+    It is a key-value pairs where the values can be of any type (string, number,
+    boolean, object, array, etc.).
+    """
+
+
+class EarningAttributes(BaseModel):
+    metadata: EarningAttributesMetadata
+
+
+class Earning(BaseModel):
+    amount: Optional[int] = None
+    """The earnings amount in cents."""
+
+    currency: Optional[str] = None
+    """The earnings currency code."""
+
+    hours: Optional[float] = None
+    """The number of hours associated with this earning.
+
+    (For salaried employees, this could be hours per pay period, `0` or `null`,
+    depending on the provider).
+    """
+
+    name: Optional[str] = None
+    """The exact name of the deduction from the pay statement."""
+
+    type: Optional[
+        Literal[
+            "salary",
+            "wage",
+            "reimbursement",
+            "overtime",
+            "severance",
+            "double_overtime",
+            "pto",
+            "sick",
+            "bonus",
+            "commission",
+            "tips",
+            "1099",
+            "other",
+        ]
+    ] = None
+    """The type of earning."""
+
+    attributes: Optional[EarningAttributes] = None
+
+
+class EmployeeDeductionAttributesMetadata(BaseModel):
+    metadata: Dict[str, Optional[object]]
+    """The metadata to be attached to the entity by existing rules.
+
+    It is a key-value pairs where the values can be of any type (string, number,
+    boolean, object, array, etc.).
+    """
+
+
+class EmployeeDeductionAttributes(BaseModel):
+    metadata: EmployeeDeductionAttributesMetadata
+
+
+class EmployeeDeduction(BaseModel):
+    amount: Optional[int] = None
+    """The deduction amount in cents."""
+
+    currency: Optional[str] = None
+    """The deduction currency."""
+
+    name: Optional[str] = None
+    """The deduction name from the pay statement."""
+
+    pre_tax: Optional[bool] = None
+    """Boolean indicating if the deduction is pre-tax."""
+
+    type: Optional[BenefitType] = None
+    """Type of benefit."""
+
+    attributes: Optional[EmployeeDeductionAttributes] = None
+
+
+class EmployerContributionAttributesMetadata(BaseModel):
+    metadata: Dict[str, Optional[object]]
+    """The metadata to be attached to the entity by existing rules.
+
+    It is a key-value pairs where the values can be of any type (string, number,
+    boolean, object, array, etc.).
+    """
+
+
+class EmployerContributionAttributes(BaseModel):
+    metadata: EmployerContributionAttributesMetadata
+
+
+class EmployerContribution(BaseModel):
+    currency: Optional[str] = None
+    """The contribution currency."""
+
+    name: Optional[str] = None
+    """The contribution name from the pay statement."""
+
+    type: Optional[BenefitType] = None
+    """Type of benefit."""
+
+    amount: Optional[int] = None
+    """The contribution amount in cents."""
+
+    attributes: Optional[EmployerContributionAttributes] = None
+
+
+class TaxAttributesMetadata(BaseModel):
+    metadata: Dict[str, Optional[object]]
+    """The metadata to be attached to the entity by existing rules.
+
+    It is a key-value pairs where the values can be of any type (string, number,
+    boolean, object, array, etc.).
+    """
+
+
+class TaxAttributes(BaseModel):
+    metadata: TaxAttributesMetadata
+
+
+class Tax(BaseModel):
+    currency: Optional[str] = None
+    """The currency code."""
+
+    employer: Optional[bool] = None
+    """`true` if the amount is paid by the employers."""
+
+    name: Optional[str] = None
+    """The exact name of tax from the pay statement."""
+
+    type: Optional[Literal["state", "federal", "local", "fica"]] = None
+    """The type of taxes."""
+
+    amount: Optional[int] = None
+    """The tax amount in cents."""
+
+    attributes: Optional[TaxAttributes] = None
+
+
+class PayStatement(BaseModel):
+    earnings: Optional[List[Optional[Earning]]] = None
+    """The array of earnings objects associated with this pay statement"""
+
+    employee_deductions: Optional[List[Optional[EmployeeDeduction]]] = None
+    """The array of deductions objects associated with this pay statement."""
+
+    employer_contributions: Optional[List[Optional[EmployerContribution]]] = None
+
+    gross_pay: Optional[Money] = None
+
+    individual_id: str
+    """A stable Finch `id` (UUID v4) for an individual in the company"""
+
+    net_pay: Optional[Money] = None
+
+    payment_method: Optional[Literal["check", "direct_deposit", "other"]] = None
+    """The payment method."""
+
+    taxes: Optional[List[Optional[Tax]]] = None
+    """The array of taxes objects associated with this pay statement."""
+
+    total_hours: Optional[float] = None
+    """The number of hours worked for this pay period"""
+
+    type: Optional[Literal["off_cycle_payroll", "one_time_payment", "regular_payroll"]] = None
+    """The type of the payment associated with the pay statement."""

src/finch/types/hris/pay_statement_data_sync_in_progress.py

@@ -0,0 +1,17 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing_extensions import Literal
+
+from ..._models import BaseModel
+
+__all__ = ["PayStatementDataSyncInProgress"]
+
+
+class PayStatementDataSyncInProgress(BaseModel):
+    code: Literal[202]
+
+    finch_code: Literal["data_sync_in_progress"]
+
+    message: Literal["The pay statements for this payment are being fetched. Please check back later."]
+
+    name: Literal["accepted"]