feat(api): add /jobs endpoints (#210)

Author: stainless-bot

.stats.yml

@@ -1 +1 @@
-configured_endpoints: 19
+configured_endpoints: 23

api.md

@@ -1,7 +1,7 @@
 # Shared Types
 
 ```python
-from finch.types import OperationSupport, OperationSupportMatrix
+from finch.types import OperationSupport, OperationSupportMatrix, Paging
 ```
 
 # Finch
@@ -16,7 +16,7 @@ Methods:
 Types:
 
 ```python
-from finch.types import Income, Location, Money, Paging
+from finch.types import Income, Location, Money
 ```
 
 ## CompanyResource
@@ -186,3 +186,31 @@ from finch.types import RequestForwardingForwardResponse
 Methods:
 
 - <code title="post /forward">client.request_forwarding.<a href="./src/finch/resources/request_forwarding.py">forward</a>(\*\*<a href="src/finch/types/request_forwarding_forward_params.py">params</a>) -> <a href="./src/finch/types/request_forwarding_forward_response.py">RequestForwardingForwardResponse</a></code>
+
+# Jobs
+
+## Automated
+
+Types:
+
+```python
+from finch.types.jobs import AutomatedAsyncJob, AutomatedCreateResponse
+```
+
+Methods:
+
+- <code title="post /jobs/automated">client.jobs.automated.<a href="./src/finch/resources/jobs/automated.py">create</a>(\*\*<a href="src/finch/types/jobs/automated_create_params.py">params</a>) -> <a href="./src/finch/types/jobs/automated_create_response.py">AutomatedCreateResponse</a></code>
+- <code title="get /jobs/automated/{job_id}">client.jobs.automated.<a href="./src/finch/resources/jobs/automated.py">retrieve</a>(job_id) -> <a href="./src/finch/types/jobs/automated_async_job.py">AutomatedAsyncJob</a></code>
+- <code title="get /jobs/automated">client.jobs.automated.<a href="./src/finch/resources/jobs/automated.py">list</a>(\*\*<a href="src/finch/types/jobs/automated_list_params.py">params</a>) -> <a href="./src/finch/types/jobs/automated_async_job.py">SyncPage[AutomatedAsyncJob]</a></code>
+
+## Manual
+
+Types:
+
+```python
+from finch.types.jobs import ManualAsyncJob
+```
+
+Methods:
+
+- <code title="get /jobs/manual/{job_id}">client.jobs.manual.<a href="./src/finch/resources/jobs/manual.py">retrieve</a>(job_id) -> <a href="./src/finch/types/jobs/manual_async_job.py">ManualAsyncJob</a></code>

src/finch/_client.py

@@ -53,6 +53,7 @@ class Finch(SyncAPIClient):
     account: resources.Account
     webhooks: resources.Webhooks
     request_forwarding: resources.RequestForwarding
+    jobs: resources.Jobs
     with_raw_response: FinchWithRawResponse
 
     # client options
@@ -136,6 +137,7 @@ def __init__(
         self.account = resources.Account(self)
         self.webhooks = resources.Webhooks(self)
         self.request_forwarding = resources.RequestForwarding(self)
+        self.jobs = resources.Jobs(self)
         self.with_raw_response = FinchWithRawResponse(self)
 
     @property
@@ -357,6 +359,7 @@ class AsyncFinch(AsyncAPIClient):
     account: resources.AsyncAccount
     webhooks: resources.AsyncWebhooks
     request_forwarding: resources.AsyncRequestForwarding
+    jobs: resources.AsyncJobs
     with_raw_response: AsyncFinchWithRawResponse
 
     # client options
@@ -440,6 +443,7 @@ def __init__(
         self.account = resources.AsyncAccount(self)
         self.webhooks = resources.AsyncWebhooks(self)
         self.request_forwarding = resources.AsyncRequestForwarding(self)
+        self.jobs = resources.AsyncJobs(self)
         self.with_raw_response = AsyncFinchWithRawResponse(self)
 
     @property
@@ -664,6 +668,7 @@ def __init__(self, client: Finch) -> None:
         self.providers = resources.ProvidersWithRawResponse(client.providers)
         self.account = resources.AccountWithRawResponse(client.account)
         self.request_forwarding = resources.RequestForwardingWithRawResponse(client.request_forwarding)
+        self.jobs = resources.JobsWithRawResponse(client.jobs)
 
 
 class AsyncFinchWithRawResponse:
@@ -672,6 +677,7 @@ def __init__(self, client: AsyncFinch) -> None:
         self.providers = resources.AsyncProvidersWithRawResponse(client.providers)
         self.account = resources.AsyncAccountWithRawResponse(client.account)
         self.request_forwarding = resources.AsyncRequestForwardingWithRawResponse(client.request_forwarding)
+        self.jobs = resources.AsyncJobsWithRawResponse(client.jobs)
 
 
 Client = Finch

src/finch/pagination.py

@@ -5,11 +5,11 @@
 
 from httpx import Response
 
-from .types import Paging
 from ._types import ModelT
 from ._utils import is_mapping
 from ._models import BaseModel
 from ._base_client import BasePage, PageInfo, BaseSyncPage, BaseAsyncPage
+from .types.shared import Paging
 
 __all__ = [
     "SyncSinglePage",
@@ -18,6 +18,8 @@
     "AsyncResponsesPage",
     "SyncIndividualsPage",
     "AsyncIndividualsPage",
+    "SyncPage",
+    "AsyncPage",
 ]
 
 _BaseModelT = TypeVar("_BaseModelT", bound=BaseModel)
@@ -161,3 +163,61 @@ def next_page_info(self) -> Optional[PageInfo]:
             return PageInfo(params={"offset": current_count})
 
         return None
+
+
+PagePaging = Paging
+"""This is deprecated, Paging should be used instead"""
+
+
+class SyncPage(BaseSyncPage[ModelT], BasePage[ModelT], Generic[ModelT]):
+    paging: Paging
+    data: List[ModelT]
+
+    @override
+    def _get_page_items(self) -> List[ModelT]:
+        return self.data
+
+    @override
+    def next_page_info(self) -> Optional[PageInfo]:
+        offset = self.paging.offset
+        if offset is None:
+            return None
+
+        length = len(self.data)
+        current_count = offset + length
+
+        total_count = self.paging.count
+        if total_count is None:
+            return None
+
+        if current_count < total_count:
+            return PageInfo(params={"offset": current_count})
+
+        return None
+
+
+class AsyncPage(BaseAsyncPage[ModelT], BasePage[ModelT], Generic[ModelT]):
+    paging: Paging
+    data: List[ModelT]
+
+    @override
+    def _get_page_items(self) -> List[ModelT]:
+        return self.data
+
+    @override
+    def next_page_info(self) -> Optional[PageInfo]:
+        offset = self.paging.offset
+        if offset is None:
+            return None
+
+        length = len(self.data)
+        current_count = offset + length
+
+        total_count = self.paging.count
+        if total_count is None:
+            return None
+
+        if current_count < total_count:
+            return PageInfo(params={"offset": current_count})
+
+        return None

src/finch/resources/__init__.py

@@ -1,6 +1,7 @@
 # File generated from our OpenAPI spec by Stainless.
 
 from .hris import HRIS, AsyncHRIS, HRISWithRawResponse, AsyncHRISWithRawResponse
+from .jobs import Jobs, AsyncJobs, JobsWithRawResponse, AsyncJobsWithRawResponse
 from .account import (
     Account,
     AsyncAccount,
@@ -40,4 +41,8 @@
     "AsyncRequestForwarding",
     "RequestForwardingWithRawResponse",
     "AsyncRequestForwardingWithRawResponse",
+    "Jobs",
+    "AsyncJobs",
+    "JobsWithRawResponse",
+    "AsyncJobsWithRawResponse",
 ]

src/finch/resources/jobs/__init__.py

@@ -0,0 +1,30 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from .jobs import Jobs, AsyncJobs, JobsWithRawResponse, AsyncJobsWithRawResponse
+from .manual import (
+    Manual,
+    AsyncManual,
+    ManualWithRawResponse,
+    AsyncManualWithRawResponse,
+)
+from .automated import (
+    Automated,
+    AsyncAutomated,
+    AutomatedWithRawResponse,
+    AsyncAutomatedWithRawResponse,
+)
+
+__all__ = [
+    "Automated",
+    "AsyncAutomated",
+    "AutomatedWithRawResponse",
+    "AsyncAutomatedWithRawResponse",
+    "Manual",
+    "AsyncManual",
+    "ManualWithRawResponse",
+    "AsyncManualWithRawResponse",
+    "Jobs",
+    "AsyncJobs",
+    "JobsWithRawResponse",
+    "AsyncJobsWithRawResponse",
+]