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-f09e5f2c555d7ee764478b7bc73e92cd21f403d6ec189be14574c8367bc131ce.yml
-openapi_spec_hash: bd0a8e001f14132c105992d40149909a
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch%2Ffinch-331df2398447990a86899b05ac569534b6a7e4ff1d73a319d57f67b34a201fb7.yml
+openapi_spec_hash: 6e57516524c0519e90213c0554b26ab4
 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",
-        "s125_medical",
-        "s125_dental",
-        "s125_vision",
-        "hsa_pre",
-        "hsa_post",
-        "fsa_medical",
-        "fsa_dependent_care",
-        "simple_ira",
-        "simple",
         "commuter",
         "custom_post_tax",
         "custom_pre_tax",
+        "fsa_dependent_care",
+        "fsa_medical",
+        "hsa_post",
+        "hsa_pre",
+        "s125_dental",
+        "s125_medical",
+        "s125_vision",
+        "simple",
+        "simple_ira",
     ]
 ]

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

@@ -9,18 +9,18 @@
 
 
 class Attributes(BaseModel):
-    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.
     """
 
+    employer: Optional[bool] = None
+    """`true` if the amount is paid by the employers.
+
+    This field is only available for taxes.
+    """
+
     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: Optional[Attributes] = None
+    attributes: Attributes
     """The attributes of the pay statement item."""
 
-    category: Optional[Literal["earnings", "taxes", "employee_deductions", "employer_contributions"]] = None
+    category: Literal["earnings", "taxes", "employee_deductions", "employer_contributions"]
     """The category of the pay statement item."""
 
-    name: Optional[str] = None
+    name: str
     """The name of the pay statement item."""

src/finch/types/hris/pay_statement.py

@@ -25,7 +25,7 @@
 
 
 class EarningAttributesMetadata(BaseModel):
-    metadata: Optional[Dict[str, Optional[object]]] = None
+    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,
@@ -34,15 +34,13 @@ class EarningAttributesMetadata(BaseModel):
 
 
 class EarningAttributes(BaseModel):
-    metadata: Optional[EarningAttributesMetadata] = None
+    metadata: EarningAttributesMetadata
 
 
 class Earning(BaseModel):
     amount: Optional[int] = None
     """The earnings amount in cents."""
 
-    attributes: Optional[EarningAttributes] = None
-
     currency: Optional[str] = None
     """The earnings currency code."""
 
@@ -75,9 +73,11 @@ class Earning(BaseModel):
     ] = None
     """The type of earning."""
 
+    attributes: Optional[EarningAttributes] = None
+
 
 class EmployeeDeductionAttributesMetadata(BaseModel):
-    metadata: Optional[Dict[str, Optional[object]]] = None
+    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,
@@ -86,15 +86,13 @@ class EmployeeDeductionAttributesMetadata(BaseModel):
 
 
 class EmployeeDeductionAttributes(BaseModel):
-    metadata: Optional[EmployeeDeductionAttributesMetadata] = None
+    metadata: EmployeeDeductionAttributesMetadata
 
 
 class EmployeeDeduction(BaseModel):
     amount: Optional[int] = None
     """The deduction amount in cents."""
 
-    attributes: Optional[EmployeeDeductionAttributes] = None
-
     currency: Optional[str] = None
     """The deduction currency."""
 
@@ -107,9 +105,11 @@ class EmployeeDeduction(BaseModel):
     type: Optional[BenefitType] = None
     """Type of benefit."""
 
+    attributes: Optional[EmployeeDeductionAttributes] = None
+
 
 class EmployerContributionAttributesMetadata(BaseModel):
-    metadata: Optional[Dict[str, Optional[object]]] = None
+    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,
@@ -118,15 +118,13 @@ class EmployerContributionAttributesMetadata(BaseModel):
 
 
 class EmployerContributionAttributes(BaseModel):
-    metadata: Optional[EmployerContributionAttributesMetadata] = None
+    metadata: EmployerContributionAttributesMetadata
 
 
 class EmployerContribution(BaseModel):
     amount: Optional[int] = None
     """The contribution amount in cents."""
 
-    attributes: Optional[EmployerContributionAttributes] = None
-
     currency: Optional[str] = None
     """The contribution currency."""
 
@@ -136,9 +134,11 @@ class EmployerContribution(BaseModel):
     type: Optional[BenefitType] = None
     """Type of benefit."""
 
+    attributes: Optional[EmployerContributionAttributes] = None
+
 
 class TaxAttributesMetadata(BaseModel):
-    metadata: Optional[Dict[str, Optional[object]]] = None
+    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,
@@ -147,15 +147,13 @@ class TaxAttributesMetadata(BaseModel):
 
 
 class TaxAttributes(BaseModel):
-    metadata: Optional[TaxAttributesMetadata] = None
+    metadata: TaxAttributesMetadata
 
 
 class Tax(BaseModel):
     amount: Optional[int] = None
     """The tax amount in cents."""
 
-    attributes: Optional[TaxAttributes] = None
-
     currency: Optional[str] = None
     """The currency code."""
 
@@ -168,6 +166,8 @@ 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: Optional[str] = None
+    individual_id: str
     """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,16 +1,14 @@
 # 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: Optional[PayStatementResponseBody] = None
+    body: PayStatementResponseBody
 
-    code: Optional[int] = None
+    code: int
 
-    payment_id: Optional[str] = None
+    payment_id: str

src/finch/types/hris/pay_statement_response_body.py

@@ -4,13 +4,19 @@
 
 from ..._models import BaseModel
 from .pay_statement import PayStatement
-from ..shared.paging import Paging
 
-__all__ = ["PayStatementResponseBody"]
+__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)"""
 
 
 class PayStatementResponseBody(BaseModel):
-    paging: Optional[Paging] = None
+    paging: Paging
 
-    pay_statements: Optional[List[PayStatement]] = None
-    """The array of pay statements for the current payment."""
+    pay_statements: List[PayStatement]

src/finch/types/hris/payment.py

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

src/finch/types/money.py

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

src/finch/types/money_param.py

@@ -3,13 +3,13 @@
 from __future__ import annotations
 
 from typing import Optional
-from typing_extensions import TypedDict
+from typing_extensions import Required, TypedDict
 
 __all__ = ["MoneyParam"]
 
 
 class MoneyParam(TypedDict, total=False):
-    amount: Optional[int]
+    amount: Required[Optional[int]]
     """Amount for money object (in cents)"""
 
-    currency: str
+    currency: Required[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, Optional
+from typing import List
 from typing_extensions import Literal
 
 from ..._models import BaseModel
@@ -9,25 +9,15 @@
 
 
 class PayGroupListResponse(BaseModel):
-    id: Optional[str] = None
+    id: str
     """Finch id (uuidv4) for the pay group"""
 
-    name: Optional[str] = None
+    name: str
     """Name of the pay group"""
 
-    pay_frequencies: Optional[
-        List[
-            Literal[
-                "annually",
-                "semi_annually",
-                "quarterly",
-                "monthly",
-                "semi_monthly",
-                "bi_weekly",
-                "weekly",
-                "daily",
-                "other",
-            ]
+    pay_frequencies: List[
+        Literal[
+            "annually", "bi_weekly", "daily", "monthly", "other", "quarterly", "semi_annually", "semi_monthly", "weekly"
         ]
-    ] = 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", "semi_annually", "quarterly", "monthly", "semi_monthly", "bi_weekly", "weekly", "daily", "other"
+            "annually", "bi_weekly", "daily", "monthly", "other", "quarterly", "semi_annually", "semi_monthly", "weekly"
         ]
     ]
     """List of pay frequencies associated with this pay group"""