feat(api): api update

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-2450f9bcc309174bb09e7cc75c3d873240626676782a6d0aa7578395adfa80a8.yml
-openapi_spec_hash: ce0eebc26042d65a7831455ca7e9c5a8
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch%2Ffinch-5b00a0bc705b1d5bfcb5ea79c7af544766d51ec12ccc4721825664ab397789d8.yml
+openapi_spec_hash: 34891659cff31395ba7683a8153b1db5
 config_hash: 53778a0b839c4f6ad34fbba051f5e8a6

src/finch/types/hris/benefit_type.py

@@ -7,24 +7,24 @@
 
 BenefitType: TypeAlias = Optional[
     Literal[
-        "457",
         "401k",
         "401k_roth",
         "401k_loan",
         "403b",
         "403b_roth",
+        "457",
         "457_roth",
-        "commuter",
-        "custom_post_tax",
-        "custom_pre_tax",
-        "fsa_dependent_care",
-        "fsa_medical",
-        "hsa_post",
-        "hsa_pre",
-        "s125_dental",
         "s125_medical",
+        "s125_dental",
         "s125_vision",
-        "simple",
+        "hsa_pre",
+        "hsa_post",
+        "fsa_medical",
+        "fsa_dependent_care",
         "simple_ira",
+        "simple",
+        "commuter",
+        "custom_post_tax",
+        "custom_pre_tax",
     ]
 ]

src/finch/types/hris/company/pay_statement_item_list_response.py

@@ -9,18 +9,18 @@
 
 
 class Attributes(BaseModel):
-    metadata: Optional[Dict[str, Optional[object]]] = None
-    """The metadata of the pay statement item derived by the rules engine if available.
-
-    Each attribute will be a key-value pair defined by a rule.
-    """
-
     employer: Optional[bool] = None
     """`true` if the amount is paid by the employers.
 
     This field is only available for taxes.
     """
 
+    metadata: Optional[Dict[str, Optional[object]]] = None
+    """The metadata of the pay statement item derived by the rules engine if available.
+
+    Each attribute will be a key-value pair defined by a rule.
+    """
+
     pre_tax: Optional[bool] = None
     """`true` if the pay statement item is pre-tax.
 
@@ -32,11 +32,11 @@ class Attributes(BaseModel):
 
 
 class PayStatementItemListResponse(BaseModel):
-    attributes: Attributes
+    attributes: Optional[Attributes] = None
     """The attributes of the pay statement item."""
 
-    category: Literal["earnings", "taxes", "employee_deductions", "employer_contributions"]
+    category: Optional[Literal["earnings", "taxes", "employee_deductions", "employer_contributions"]] = None
     """The category of the pay statement item."""
 
-    name: str
+    name: Optional[str] = None
     """The name of the pay statement item."""

src/finch/types/hris/pay_statement.py

@@ -25,7 +25,7 @@
 
 
 class EarningAttributesMetadata(BaseModel):
-    metadata: Dict[str, Optional[object]]
+    metadata: Optional[Dict[str, Optional[object]]] = None
     """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,
@@ -34,13 +34,15 @@ class EarningAttributesMetadata(BaseModel):
 
 
 class EarningAttributes(BaseModel):
-    metadata: EarningAttributesMetadata
+    metadata: Optional[EarningAttributesMetadata] = None
 
 
 class Earning(BaseModel):
     amount: Optional[int] = None
     """The earnings amount in cents."""
 
+    attributes: Optional[EarningAttributes] = None
+
     currency: Optional[str] = None
     """The earnings currency code."""
 
@@ -73,11 +75,9 @@ class Earning(BaseModel):
     ] = None
     """The type of earning."""
 
-    attributes: Optional[EarningAttributes] = None
-
 
 class EmployeeDeductionAttributesMetadata(BaseModel):
-    metadata: Dict[str, Optional[object]]
+    metadata: Optional[Dict[str, Optional[object]]] = None
     """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,
@@ -86,13 +86,15 @@ class EmployeeDeductionAttributesMetadata(BaseModel):
 
 
 class EmployeeDeductionAttributes(BaseModel):
-    metadata: EmployeeDeductionAttributesMetadata
+    metadata: Optional[EmployeeDeductionAttributesMetadata] = None
 
 
 class EmployeeDeduction(BaseModel):
     amount: Optional[int] = None
     """The deduction amount in cents."""
 
+    attributes: Optional[EmployeeDeductionAttributes] = None
+
     currency: Optional[str] = None
     """The deduction currency."""
 
@@ -105,11 +107,9 @@ class EmployeeDeduction(BaseModel):
     type: Optional[BenefitType] = None
     """Type of benefit."""
 
-    attributes: Optional[EmployeeDeductionAttributes] = None
-
 
 class EmployerContributionAttributesMetadata(BaseModel):
-    metadata: Dict[str, Optional[object]]
+    metadata: Optional[Dict[str, Optional[object]]] = None
     """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,
@@ -118,13 +118,15 @@ class EmployerContributionAttributesMetadata(BaseModel):
 
 
 class EmployerContributionAttributes(BaseModel):
-    metadata: EmployerContributionAttributesMetadata
+    metadata: Optional[EmployerContributionAttributesMetadata] = None
 
 
 class EmployerContribution(BaseModel):
     amount: Optional[int] = None
     """The contribution amount in cents."""
 
+    attributes: Optional[EmployerContributionAttributes] = None
+
     currency: Optional[str] = None
     """The contribution currency."""
 
@@ -134,11 +136,9 @@ class EmployerContribution(BaseModel):
     type: Optional[BenefitType] = None
     """Type of benefit."""
 
-    attributes: Optional[EmployerContributionAttributes] = None
-
 
 class TaxAttributesMetadata(BaseModel):
-    metadata: Dict[str, Optional[object]]
+    metadata: Optional[Dict[str, Optional[object]]] = None
     """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,
@@ -147,13 +147,15 @@ class TaxAttributesMetadata(BaseModel):
 
 
 class TaxAttributes(BaseModel):
-    metadata: TaxAttributesMetadata
+    metadata: Optional[TaxAttributesMetadata] = None
 
 
 class Tax(BaseModel):
     amount: Optional[int] = None
     """The tax amount in cents."""
 
+    attributes: Optional[TaxAttributes] = None
+
     currency: Optional[str] = None
     """The currency code."""
 
@@ -166,8 +168,6 @@ class Tax(BaseModel):
     type: Optional[Literal["state", "federal", "local", "fica"]] = None
     """The type of taxes."""
 
-    attributes: Optional[TaxAttributes] = None
-
 
 class PayStatement(BaseModel):
     earnings: Optional[List[Optional[Earning]]] = None
@@ -180,7 +180,7 @@ class PayStatement(BaseModel):
 
     gross_pay: Optional[Money] = None
 
-    individual_id: str
+    individual_id: Optional[str] = None
     """A stable Finch `id` (UUID v4) for an individual in the company"""
 
     net_pay: Optional[Money] = None

src/finch/types/hris/pay_statement_response.py

@@ -1,14 +1,16 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
+from typing import Optional
+
 from ..._models import BaseModel
 from .pay_statement_response_body import PayStatementResponseBody
 
 __all__ = ["PayStatementResponse"]
 
 
 class PayStatementResponse(BaseModel):
-    body: PayStatementResponseBody
+    body: Optional[PayStatementResponseBody] = None
 
-    code: int
+    code: Optional[int] = None
 
-    payment_id: str
+    payment_id: Optional[str] = None

src/finch/types/hris/pay_statement_response_body.py

@@ -4,19 +4,13 @@
 
 from ..._models import BaseModel
 from .pay_statement import PayStatement
+from ..shared.paging import Paging
 
-__all__ = ["PayStatementResponseBody", "Paging"]
-
-
-class Paging(BaseModel):
-    offset: int
-    """The current start index of the returned list of elements"""
-
-    count: Optional[int] = None
-    """The total number of elements for the entire query (not just the given page)"""
+__all__ = ["PayStatementResponseBody"]
 
 
 class PayStatementResponseBody(BaseModel):
-    paging: Paging
+    paging: Optional[Paging] = None
 
-    pay_statements: List[PayStatement]
+    pay_statements: Optional[List[PayStatement]] = None
+    """The array of pay statements for the current payment."""

src/finch/types/hris/payment.py

@@ -16,7 +16,7 @@ class PayPeriod(BaseModel):
 
 
 class Payment(BaseModel):
-    id: str
+    id: Optional[str] = None
     """The unique id for the payment."""
 
     company_debit: Optional[Money] = None
@@ -40,14 +40,14 @@ class Payment(BaseModel):
         List[
             Literal[
                 "annually",
-                "bi_weekly",
-                "daily",
-                "monthly",
-                "other",
-                "quarterly",
                 "semi_annually",
+                "quarterly",
+                "monthly",
                 "semi_monthly",
+                "bi_weekly",
                 "weekly",
+                "daily",
+                "other",
             ]
         ]
     ] = None

src/finch/types/money.py

@@ -11,4 +11,4 @@ class Money(BaseModel):
     amount: Optional[int] = None
     """Amount for money object (in cents)"""
 
-    currency: str
+    currency: Optional[str] = None

src/finch/types/money_param.py

@@ -3,13 +3,13 @@
 from __future__ import annotations
 
 from typing import Optional
-from typing_extensions import Required, TypedDict
+from typing_extensions import TypedDict
 
 __all__ = ["MoneyParam"]
 
 
 class MoneyParam(TypedDict, total=False):
-    amount: Required[Optional[int]]
+    amount: Optional[int]
     """Amount for money object (in cents)"""
 
-    currency: Required[str]
+    currency: str

src/finch/types/payroll/pay_group_list_response.py

@@ -1,6 +1,6 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-from typing import List
+from typing import List, Optional
 from typing_extensions import Literal
 
 from ..._models import BaseModel
@@ -9,15 +9,25 @@
 
 
 class PayGroupListResponse(BaseModel):
-    id: str
+    id: Optional[str] = None
     """Finch id (uuidv4) for the pay group"""
 
-    name: str
+    name: Optional[str] = None
     """Name of the pay group"""
 
-    pay_frequencies: List[
-        Literal[
-            "annually", "bi_weekly", "daily", "monthly", "other", "quarterly", "semi_annually", "semi_monthly", "weekly"
+    pay_frequencies: Optional[
+        List[
+            Literal[
+                "annually",
+                "semi_annually",
+                "quarterly",
+                "monthly",
+                "semi_monthly",
+                "bi_weekly",
+                "weekly",
+                "daily",
+                "other",
+            ]
         ]
-    ]
+    ] = None
     """List of pay frequencies associated with this pay group"""

src/finch/types/payroll/pay_group_retrieve_response.py

@@ -19,7 +19,7 @@ class PayGroupRetrieveResponse(BaseModel):
 
     pay_frequencies: List[
         Literal[
-            "annually", "bi_weekly", "daily", "monthly", "other", "quarterly", "semi_annually", "semi_monthly", "weekly"
+            "annually", "semi_annually", "quarterly", "monthly", "semi_monthly", "bi_weekly", "weekly", "daily", "other"
         ]
     ]
     """List of pay frequencies associated with this pay group"""