samsara-api 0.0.1__py3-none-any.whl → 0.0.2__py3-none-any.whl

samsara/form_submissions/client.py

@@ -4,6 +4,7 @@ import datetime as dt
 import typing
 
 from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ..core.pagination import AsyncPager, SyncPager
 from ..core.request_options import RequestOptions
 from ..types.form_submission_request_approval_details_request_body import (
     FormSubmissionRequestApprovalDetailsRequestBody,
@@ -12,13 +13,11 @@ from ..types.form_submission_request_assigned_to_request_body import FormSubmiss
 from ..types.form_submission_request_field_input_object_request_body import (
     FormSubmissionRequestFieldInputObjectRequestBody,
 )
+from ..types.form_submission_response_object_response_body import FormSubmissionResponseObjectResponseBody
 from ..types.form_submissions_get_form_submissions_response_body import FormSubmissionsGetFormSubmissionsResponseBody
-from ..types.form_submissions_get_form_submissions_stream_response_body import (
-    FormSubmissionsGetFormSubmissionsStreamResponseBody,
-)
 from ..types.form_submissions_patch_form_submission_response_body import FormSubmissionsPatchFormSubmissionResponseBody
 from ..types.form_submissions_post_form_submission_response_body import FormSubmissionsPostFormSubmissionResponseBody
-from ..types.form_template_reference_object_request_body import FormTemplateReferenceObjectRequestBody
+from ..types.form_template_request_object_request_body import FormTemplateRequestObjectRequestBody
 from .pdf_exports.client import AsyncPdfExportsClient, PdfExportsClient
 from .raw_client import AsyncRawFormSubmissionsClient, RawFormSubmissionsClient
 from .types.form_submissions_patch_form_submission_request_body_status import (
@@ -53,13 +52,11 @@ class FormSubmissionsClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> FormSubmissionsGetFormSubmissionsResponseBody:
         """
-        Returns all form submissions data for the specified IDs.
-
-        **Beta:** This endpoint is in beta and is likely to change before being broadly available. Reach out to your Samsara Representative to have Forms APIs enabled for your organization.
+        Returns all form submissions data for the specified list of IDs.
 
          <b>Rate limit:</b> 5 requests/sec (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).
 
-        To use this endpoint, select **Read Form Submissions** under the Closed Beta category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
+        To use this endpoint, select **Read Form Submissions** under the Forms category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
 
 
          **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.
@@ -70,7 +67,7 @@ class FormSubmissionsClient:
             A comma-separated list containing up to 100 form submission IDs to filter on. Can be either a unique Samsara ID or an [external ID](https://developers.samsara.com/docs/external-ids) for the form submission.
 
         include : typing.Optional[typing.Union[str, typing.Sequence[str]]]
-            A comma-separated list of strings indicating whether to return additional information. Valid values: `externalIds`, `fieldLabels`
+            A comma-separated list of strings indicating whether to return additional information. Valid values: `externalIds`
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -95,7 +92,7 @@ class FormSubmissionsClient:
     def create(
         self,
         *,
-        form_template: FormTemplateReferenceObjectRequestBody,
+        form_template: FormTemplateRequestObjectRequestBody,
         assigned_to: typing.Optional[FormSubmissionRequestAssignedToRequestBody] = OMIT,
         due_at_time: typing.Optional[dt.datetime] = OMIT,
         fields: typing.Optional[typing.Sequence[FormSubmissionRequestFieldInputObjectRequestBody]] = OMIT,
@@ -105,20 +102,18 @@ class FormSubmissionsClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> FormSubmissionsPostFormSubmissionResponseBody:
         """
-        Creates a form submission.
-
-        **Beta:** This endpoint is in beta and is likely to change before being broadly available. Reach out to your Samsara Representative to have Forms APIs enabled for your organization.
+        Creates a form submission and assigns it to an individual worker. This endpoint can be used to create an empty or partially complete form submission and assign it to a worker.
 
          <b>Rate limit:</b> 100 requests/min (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).
 
-        To use this endpoint, select **Write Form Submissions** under the Closed Beta category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
+        To use this endpoint, select **Write Form Submissions** under the Forms category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
 
 
          **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.
 
         Parameters
         ----------
-        form_template : FormTemplateReferenceObjectRequestBody
+        form_template : FormTemplateRequestObjectRequestBody
 
         assigned_to : typing.Optional[FormSubmissionRequestAssignedToRequestBody]
 
@@ -147,13 +142,13 @@ class FormSubmissionsClient:
 
         Examples
         --------
-        from samsara import FormTemplateReferenceObjectRequestBody, Samsara
+        from samsara import FormTemplateRequestObjectRequestBody, Samsara
 
         client = Samsara(
             token="YOUR_TOKEN",
         )
         client.form_submissions.create(
-            form_template=FormTemplateReferenceObjectRequestBody(
+            form_template=FormTemplateRequestObjectRequestBody(
                 id="9814a1fa-f0c6-408b-bf85-51dc3bc71ac7",
                 revision_id="1214a1fa-f0c6-408b-bf85-51dc3bc71ac7",
             ),
@@ -187,11 +182,9 @@ class FormSubmissionsClient:
         """
         Updates an instance of a form submission.
 
-        **Beta:** This endpoint is in beta and is likely to change before being broadly available. Reach out to your Samsara Representative to have Forms APIs enabled for your organization.
-
          <b>Rate limit:</b> 100 requests/min (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).
 
-        To use this endpoint, select **Write Form Submissions** under the Closed Beta category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
+        To use this endpoint, select **Write Form Submissions** under the Forms category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
 
 
          **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.
@@ -265,15 +258,13 @@ class FormSubmissionsClient:
         include: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
         assigned_to_route_stop_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> FormSubmissionsGetFormSubmissionsStreamResponseBody:
+    ) -> SyncPager[FormSubmissionResponseObjectResponseBody]:
         """
         Returns all form submissions data that has been created or modified for your organization based on the time parameters passed in. Results are paginated and are sorted by last modified date. If you include an endTime, the endpoint will return data up until that point (exclusive). If you don’t include an endTime, you can continue to poll the API real-time with the pagination cursor that gets returned on every call.
 
-        **Beta:** This endpoint is in beta and is likely to change before being broadly available. Reach out to your Samsara Representative to have Forms APIs enabled for your organization.
-
          <b>Rate limit:</b> 5 requests/sec (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).
 
-        To use this endpoint, select **Read Form Submissions** under the Closed Beta category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
+        To use this endpoint, select **Read Form Submissions** under the Forms category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
 
 
          **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.
@@ -299,7 +290,7 @@ class FormSubmissionsClient:
             A comma-separated list containing up to 50 user IDs to filter data to.
 
         include : typing.Optional[typing.Union[str, typing.Sequence[str]]]
-            A comma-separated list of strings indicating whether to return additional information. Valid values: `externalIds`, `fieldLabels`
+            A comma-separated list of strings indicating whether to return additional information. Valid values: `externalIds`
 
         assigned_to_route_stop_ids : typing.Optional[typing.Union[str, typing.Sequence[str]]]
             A comma-separated list containing up to 50 route stop IDs to filter data to.
@@ -309,7 +300,7 @@ class FormSubmissionsClient:
 
         Returns
         -------
-        FormSubmissionsGetFormSubmissionsStreamResponseBody
+        SyncPager[FormSubmissionResponseObjectResponseBody]
             OK response.
 
         Examples
@@ -319,11 +310,16 @@ class FormSubmissionsClient:
         client = Samsara(
             token="YOUR_TOKEN",
         )
-        client.form_submissions.stream(
+        response = client.form_submissions.stream(
             start_time="startTime",
         )
+        for item in response:
+            yield item
+        # alternatively, you can paginate page-by-page
+        for page in response.iter_pages():
+            yield page
         """
-        _response = self._raw_client.stream(
+        return self._raw_client.stream(
             start_time=start_time,
             end_time=end_time,
             after=after,
@@ -334,7 +330,6 @@ class FormSubmissionsClient:
             assigned_to_route_stop_ids=assigned_to_route_stop_ids,
             request_options=request_options,
         )
-        return _response.data
 
 
 class AsyncFormSubmissionsClient:
@@ -361,13 +356,11 @@ class AsyncFormSubmissionsClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> FormSubmissionsGetFormSubmissionsResponseBody:
         """
-        Returns all form submissions data for the specified IDs.
-
-        **Beta:** This endpoint is in beta and is likely to change before being broadly available. Reach out to your Samsara Representative to have Forms APIs enabled for your organization.
+        Returns all form submissions data for the specified list of IDs.
 
          <b>Rate limit:</b> 5 requests/sec (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).
 
-        To use this endpoint, select **Read Form Submissions** under the Closed Beta category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
+        To use this endpoint, select **Read Form Submissions** under the Forms category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
 
 
          **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.
@@ -378,7 +371,7 @@ class AsyncFormSubmissionsClient:
             A comma-separated list containing up to 100 form submission IDs to filter on. Can be either a unique Samsara ID or an [external ID](https://developers.samsara.com/docs/external-ids) for the form submission.
 
         include : typing.Optional[typing.Union[str, typing.Sequence[str]]]
-            A comma-separated list of strings indicating whether to return additional information. Valid values: `externalIds`, `fieldLabels`
+            A comma-separated list of strings indicating whether to return additional information. Valid values: `externalIds`
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -411,7 +404,7 @@ class AsyncFormSubmissionsClient:
     async def create(
         self,
         *,
-        form_template: FormTemplateReferenceObjectRequestBody,
+        form_template: FormTemplateRequestObjectRequestBody,
         assigned_to: typing.Optional[FormSubmissionRequestAssignedToRequestBody] = OMIT,
         due_at_time: typing.Optional[dt.datetime] = OMIT,
         fields: typing.Optional[typing.Sequence[FormSubmissionRequestFieldInputObjectRequestBody]] = OMIT,
@@ -421,20 +414,18 @@ class AsyncFormSubmissionsClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> FormSubmissionsPostFormSubmissionResponseBody:
         """
-        Creates a form submission.
-
-        **Beta:** This endpoint is in beta and is likely to change before being broadly available. Reach out to your Samsara Representative to have Forms APIs enabled for your organization.
+        Creates a form submission and assigns it to an individual worker. This endpoint can be used to create an empty or partially complete form submission and assign it to a worker.
 
          <b>Rate limit:</b> 100 requests/min (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).
 
-        To use this endpoint, select **Write Form Submissions** under the Closed Beta category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
+        To use this endpoint, select **Write Form Submissions** under the Forms category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
 
 
          **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.
 
         Parameters
         ----------
-        form_template : FormTemplateReferenceObjectRequestBody
+        form_template : FormTemplateRequestObjectRequestBody
 
         assigned_to : typing.Optional[FormSubmissionRequestAssignedToRequestBody]
 
@@ -465,7 +456,7 @@ class AsyncFormSubmissionsClient:
         --------
         import asyncio
 
-        from samsara import AsyncSamsara, FormTemplateReferenceObjectRequestBody
+        from samsara import AsyncSamsara, FormTemplateRequestObjectRequestBody
 
         client = AsyncSamsara(
             token="YOUR_TOKEN",
@@ -474,7 +465,7 @@ class AsyncFormSubmissionsClient:
 
         async def main() -> None:
             await client.form_submissions.create(
-                form_template=FormTemplateReferenceObjectRequestBody(
+                form_template=FormTemplateRequestObjectRequestBody(
                     id="9814a1fa-f0c6-408b-bf85-51dc3bc71ac7",
                     revision_id="1214a1fa-f0c6-408b-bf85-51dc3bc71ac7",
                 ),
@@ -511,11 +502,9 @@ class AsyncFormSubmissionsClient:
         """
         Updates an instance of a form submission.
 
-        **Beta:** This endpoint is in beta and is likely to change before being broadly available. Reach out to your Samsara Representative to have Forms APIs enabled for your organization.
-
          <b>Rate limit:</b> 100 requests/min (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).
 
-        To use this endpoint, select **Write Form Submissions** under the Closed Beta category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
+        To use this endpoint, select **Write Form Submissions** under the Forms category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
 
 
          **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.
@@ -597,15 +586,13 @@ class AsyncFormSubmissionsClient:
         include: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
         assigned_to_route_stop_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> FormSubmissionsGetFormSubmissionsStreamResponseBody:
+    ) -> AsyncPager[FormSubmissionResponseObjectResponseBody]:
         """
         Returns all form submissions data that has been created or modified for your organization based on the time parameters passed in. Results are paginated and are sorted by last modified date. If you include an endTime, the endpoint will return data up until that point (exclusive). If you don’t include an endTime, you can continue to poll the API real-time with the pagination cursor that gets returned on every call.
 
-        **Beta:** This endpoint is in beta and is likely to change before being broadly available. Reach out to your Samsara Representative to have Forms APIs enabled for your organization.
-
          <b>Rate limit:</b> 5 requests/sec (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).
 
-        To use this endpoint, select **Read Form Submissions** under the Closed Beta category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
+        To use this endpoint, select **Read Form Submissions** under the Forms category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
 
 
          **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.
@@ -631,7 +618,7 @@ class AsyncFormSubmissionsClient:
             A comma-separated list containing up to 50 user IDs to filter data to.
 
         include : typing.Optional[typing.Union[str, typing.Sequence[str]]]
-            A comma-separated list of strings indicating whether to return additional information. Valid values: `externalIds`, `fieldLabels`
+            A comma-separated list of strings indicating whether to return additional information. Valid values: `externalIds`
 
         assigned_to_route_stop_ids : typing.Optional[typing.Union[str, typing.Sequence[str]]]
             A comma-separated list containing up to 50 route stop IDs to filter data to.
@@ -641,7 +628,7 @@ class AsyncFormSubmissionsClient:
 
         Returns
         -------
-        FormSubmissionsGetFormSubmissionsStreamResponseBody
+        AsyncPager[FormSubmissionResponseObjectResponseBody]
             OK response.
 
         Examples
@@ -656,14 +643,20 @@ class AsyncFormSubmissionsClient:
 
 
         async def main() -> None:
-            await client.form_submissions.stream(
+            response = await client.form_submissions.stream(
                 start_time="startTime",
             )
+            async for item in response:
+                yield item
+
+            # alternatively, you can paginate page-by-page
+            async for page in response.iter_pages():
+                yield page
 
 
         asyncio.run(main())
         """
-        _response = await self._raw_client.stream(
+        return await self._raw_client.stream(
             start_time=start_time,
             end_time=end_time,
             after=after,
@@ -674,4 +667,3 @@ class AsyncFormSubmissionsClient:
             assigned_to_route_stop_ids=assigned_to_route_stop_ids,
             request_options=request_options,
         )
-        return _response.data

samsara/form_submissions/pdf_exports/client.py

@@ -28,17 +28,15 @@ class PdfExportsClient:
         """
         return self._raw_client
 
-    def list(
+    def get(
         self, *, pdf_id: str, request_options: typing.Optional[RequestOptions] = None
     ) -> FormSubmissionsGetFormSubmissionsPdfExportsResponseBody:
         """
-        Returns a PDF export for a form submission.
-
-        **Beta:** This endpoint is in beta and is likely to change before being broadly available. Reach out to your Samsara Representative to have Forms APIs enabled for your organization.
+        Returns a PDF export that has already been generated for a form submission.
 
          <b>Rate limit:</b> 100 requests/min (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).
 
-        To use this endpoint, select **Read Form Submissions** under the Closed Beta category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
+        To use this endpoint, select **Read Form Submissions** under the Forms category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
 
 
          **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.
@@ -63,24 +61,22 @@ class PdfExportsClient:
         client = Samsara(
             token="YOUR_TOKEN",
         )
-        client.form_submissions.pdf_exports.list(
+        client.form_submissions.pdf_exports.get(
             pdf_id="pdfId",
         )
         """
-        _response = self._raw_client.list(pdf_id=pdf_id, request_options=request_options)
+        _response = self._raw_client.get(pdf_id=pdf_id, request_options=request_options)
         return _response.data
 
     def create(
         self, *, id: str, request_options: typing.Optional[RequestOptions] = None
     ) -> FormSubmissionsPostFormSubmissionsPdfExportsResponseBody:
         """
-        Creates a PDF export for a form submission.
-
-        **Beta:** This endpoint is in beta and is likely to change before being broadly available. Reach out to your Samsara Representative to have Forms APIs enabled for your organization.
+        Creates a PDF export for an existing form submission.
 
          <b>Rate limit:</b> 100 requests/min (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).
 
-        To use this endpoint, select **Write Form Submissions** under the Closed Beta category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
+        To use this endpoint, select **Write Form Submissions** under the Forms category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
 
 
          **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.
@@ -128,17 +124,15 @@ class AsyncPdfExportsClient:
         """
         return self._raw_client
 
-    async def list(
+    async def get(
         self, *, pdf_id: str, request_options: typing.Optional[RequestOptions] = None
     ) -> FormSubmissionsGetFormSubmissionsPdfExportsResponseBody:
         """
-        Returns a PDF export for a form submission.
-
-        **Beta:** This endpoint is in beta and is likely to change before being broadly available. Reach out to your Samsara Representative to have Forms APIs enabled for your organization.
+        Returns a PDF export that has already been generated for a form submission.
 
          <b>Rate limit:</b> 100 requests/min (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).
 
-        To use this endpoint, select **Read Form Submissions** under the Closed Beta category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
+        To use this endpoint, select **Read Form Submissions** under the Forms category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
 
 
          **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.
@@ -168,27 +162,25 @@ class AsyncPdfExportsClient:
 
 
         async def main() -> None:
-            await client.form_submissions.pdf_exports.list(
+            await client.form_submissions.pdf_exports.get(
                 pdf_id="pdfId",
             )
 
 
         asyncio.run(main())
         """
-        _response = await self._raw_client.list(pdf_id=pdf_id, request_options=request_options)
+        _response = await self._raw_client.get(pdf_id=pdf_id, request_options=request_options)
         return _response.data
 
     async def create(
         self, *, id: str, request_options: typing.Optional[RequestOptions] = None
     ) -> FormSubmissionsPostFormSubmissionsPdfExportsResponseBody:
         """
-        Creates a PDF export for a form submission.
-
-        **Beta:** This endpoint is in beta and is likely to change before being broadly available. Reach out to your Samsara Representative to have Forms APIs enabled for your organization.
+        Creates a PDF export for an existing form submission.
 
          <b>Rate limit:</b> 100 requests/min (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).
 
-        To use this endpoint, select **Write Form Submissions** under the Closed Beta category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
+        To use this endpoint, select **Write Form Submissions** under the Forms category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
 
 
          **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.

samsara/form_submissions/pdf_exports/raw_client.py

@@ -29,17 +29,15 @@ class RawPdfExportsClient:
     def __init__(self, *, client_wrapper: SyncClientWrapper):
         self._client_wrapper = client_wrapper
 
-    def list(
+    def get(
         self, *, pdf_id: str, request_options: typing.Optional[RequestOptions] = None
     ) -> HttpResponse[FormSubmissionsGetFormSubmissionsPdfExportsResponseBody]:
         """
-        Returns a PDF export for a form submission.
-
-        **Beta:** This endpoint is in beta and is likely to change before being broadly available. Reach out to your Samsara Representative to have Forms APIs enabled for your organization.
+        Returns a PDF export that has already been generated for a form submission.
 
          <b>Rate limit:</b> 100 requests/min (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).
 
-        To use this endpoint, select **Read Form Submissions** under the Closed Beta category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
+        To use this endpoint, select **Read Form Submissions** under the Forms category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
 
 
          **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.
@@ -183,13 +181,11 @@ class RawPdfExportsClient:
         self, *, id: str, request_options: typing.Optional[RequestOptions] = None
     ) -> HttpResponse[FormSubmissionsPostFormSubmissionsPdfExportsResponseBody]:
         """
-        Creates a PDF export for a form submission.
-
-        **Beta:** This endpoint is in beta and is likely to change before being broadly available. Reach out to your Samsara Representative to have Forms APIs enabled for your organization.
+        Creates a PDF export for an existing form submission.
 
          <b>Rate limit:</b> 100 requests/min (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).
 
-        To use this endpoint, select **Write Form Submissions** under the Closed Beta category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
+        To use this endpoint, select **Write Form Submissions** under the Forms category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
 
 
          **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.
@@ -334,17 +330,15 @@ class AsyncRawPdfExportsClient:
     def __init__(self, *, client_wrapper: AsyncClientWrapper):
         self._client_wrapper = client_wrapper
 
-    async def list(
+    async def get(
         self, *, pdf_id: str, request_options: typing.Optional[RequestOptions] = None
     ) -> AsyncHttpResponse[FormSubmissionsGetFormSubmissionsPdfExportsResponseBody]:
         """
-        Returns a PDF export for a form submission.
-
-        **Beta:** This endpoint is in beta and is likely to change before being broadly available. Reach out to your Samsara Representative to have Forms APIs enabled for your organization.
+        Returns a PDF export that has already been generated for a form submission.
 
          <b>Rate limit:</b> 100 requests/min (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).
 
-        To use this endpoint, select **Read Form Submissions** under the Closed Beta category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
+        To use this endpoint, select **Read Form Submissions** under the Forms category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
 
 
          **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.
@@ -488,13 +482,11 @@ class AsyncRawPdfExportsClient:
         self, *, id: str, request_options: typing.Optional[RequestOptions] = None
     ) -> AsyncHttpResponse[FormSubmissionsPostFormSubmissionsPdfExportsResponseBody]:
         """
-        Creates a PDF export for a form submission.
-
-        **Beta:** This endpoint is in beta and is likely to change before being broadly available. Reach out to your Samsara Representative to have Forms APIs enabled for your organization.
+        Creates a PDF export for an existing form submission.
 
          <b>Rate limit:</b> 100 requests/min (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).
 
-        To use this endpoint, select **Write Form Submissions** under the Closed Beta category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
+        To use this endpoint, select **Write Form Submissions** under the Forms category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
 
 
          **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.