diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock index 2f3cf847..dba4972b 100644 --- a/.speakeasy/workflow.lock +++ b/.speakeasy/workflow.lock @@ -2,35 +2,35 @@ speakeasyVersion: 1.525.2 sources: Gusto-App-Int-OAS: sourceNamespace: gusto-app-int-oas - sourceRevisionDigest: sha256:689628279a41eeb057e1c7afdca8152784bd5f9c2b58efa4bc1665fc4a209577 - sourceBlobDigest: sha256:81ba6d3af1a240459cf53438bb3b5b518d869062b7dd32abfa212c70952b5886 + sourceRevisionDigest: sha256:955b8bb3ee659411a247244f32f371dee0c7491b3c2f11844de00ca2ac297ae7 + sourceBlobDigest: sha256:26784ddebe266eeff70b25e0084326a16bcc7180d91c35826e319a6c8326b178 tags: - latest - - speakeasy-sdk-regen-1743553451 + - speakeasy-sdk-regen-1743812597 - "2024-04-01" Gusto-OAS: sourceNamespace: gusto-oas - sourceRevisionDigest: sha256:20cf22a6e926e505aa744b6c012c764f2add3299c5a5fd4f623162b518b3c9b6 - sourceBlobDigest: sha256:a5d5ddef31610735f102cde75d6c827223f5382ebbd680161128fd7e2b242c36 + sourceRevisionDigest: sha256:7b2c1314f9175f26d8836d3ec840add2dc843d8d9393cd1c8b0b18cf049f9bb1 + sourceBlobDigest: sha256:c1616791d0cd06741ea410696a26c24e7f2365722a80beb48250ec78b6f63e00 tags: - latest - - speakeasy-sdk-regen-1743553451 + - speakeasy-sdk-regen-1743812597 - "2024-04-01" targets: gusto: source: Gusto-OAS sourceNamespace: gusto-oas - sourceRevisionDigest: sha256:20cf22a6e926e505aa744b6c012c764f2add3299c5a5fd4f623162b518b3c9b6 - sourceBlobDigest: sha256:a5d5ddef31610735f102cde75d6c827223f5382ebbd680161128fd7e2b242c36 + sourceRevisionDigest: sha256:7b2c1314f9175f26d8836d3ec840add2dc843d8d9393cd1c8b0b18cf049f9bb1 + sourceBlobDigest: sha256:c1616791d0cd06741ea410696a26c24e7f2365722a80beb48250ec78b6f63e00 codeSamplesNamespace: gusto-oas-python-code-samples - codeSamplesRevisionDigest: sha256:0a063a27ea60e9873d6294ed5ec3c241d735406c892fbe9df2a4a8b0dc93fc49 + codeSamplesRevisionDigest: sha256:a19675574df675e2741598f0898c065747875052d7fe2e0e07cf049a05f179ed gusto-app-int: source: Gusto-App-Int-OAS sourceNamespace: gusto-app-int-oas - sourceRevisionDigest: sha256:689628279a41eeb057e1c7afdca8152784bd5f9c2b58efa4bc1665fc4a209577 - sourceBlobDigest: sha256:81ba6d3af1a240459cf53438bb3b5b518d869062b7dd32abfa212c70952b5886 + sourceRevisionDigest: sha256:955b8bb3ee659411a247244f32f371dee0c7491b3c2f11844de00ca2ac297ae7 + sourceBlobDigest: sha256:26784ddebe266eeff70b25e0084326a16bcc7180d91c35826e319a6c8326b178 codeSamplesNamespace: gusto-app-int-oas-python-code-samples - codeSamplesRevisionDigest: sha256:1f6740fe62454346fb6432f61c3eb830a5a5f7a02686cd212b41b925be25c440 + codeSamplesRevisionDigest: sha256:11527f44be0eee637544ba7c931ee207ea5c761be13507428fa44721231feb35 workflow: workflowVersion: 1.0.0 speakeasyVersion: latest diff --git a/RELEASES.md b/RELEASES.md index 5a7c2ef4..bde18fc4 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -68,4 +68,14 @@ Based on: ### Generated - [python v0.2.3] gusto_app_int ### Releases -- [PyPI v0.2.3] https://pypi.org/project/gusto_app_integration/0.2.3 - gusto_app_int \ No newline at end of file +- [PyPI v0.2.3] https://pypi.org/project/gusto_app_integration/0.2.3 - gusto_app_int + +## 2025-04-16 00:24:18 +### Changes +Based on: +- OpenAPI Doc +- Speakeasy CLI 1.525.2 (2.562.3) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v0.2.4] gusto_app_int +### Releases +- [PyPI v0.2.4] https://pypi.org/project/gusto_app_integration/0.2.4 - gusto_app_int \ No newline at end of file diff --git a/gusto_app_int/.speakeasy/gen.lock b/gusto_app_int/.speakeasy/gen.lock index 1f293f97..ec077d84 100644 --- a/gusto_app_int/.speakeasy/gen.lock +++ b/gusto_app_int/.speakeasy/gen.lock @@ -1,12 +1,12 @@ lockVersion: 2.0.0 id: 307f4640-0d05-4c9e-b275-cb7fc716aa23 management: - docChecksum: 4c5d2f1216a28f6762e454df8bdcc054 + docChecksum: d69042cc3cc17acc78abc9058ae88896 docVersion: "2024-04-01" speakeasyVersion: 1.525.2 generationVersion: 2.562.3 - releaseVersion: 0.2.3 - configChecksum: 1526a81640ebb32b6b92729d14d28fc0 + releaseVersion: 0.2.4 + configChecksum: eca361bddd83613dd8daf60c95b86c84 repoURL: https://github.com/Gusto/gusto-python-client.git repoSubDirectory: gusto_app_int installationURL: https://github.com/Gusto/gusto-python-client.git#subdirectory=gusto_app_int diff --git a/gusto_app_int/.speakeasy/gen.yaml b/gusto_app_int/.speakeasy/gen.yaml index cace5ab4..289c3a40 100644 --- a/gusto_app_int/.speakeasy/gen.yaml +++ b/gusto_app_int/.speakeasy/gen.yaml @@ -15,7 +15,7 @@ generation: oAuth2ClientCredentialsEnabled: true oAuth2PasswordEnabled: true python: - version: 0.2.3 + version: 0.2.4 additionalDependencies: dev: {} main: {} diff --git a/gusto_app_int/docs/sdks/payrolls/README.md b/gusto_app_int/docs/sdks/payrolls/README.md index 8c805b55..f8beb1e2 100644 --- a/gusto_app_int/docs/sdks/payrolls/README.md +++ b/gusto_app_int/docs/sdks/payrolls/README.md @@ -74,7 +74,6 @@ Notes: * Hour and dollar amounts are returned as string representations of numeric decimals. * Hours are represented to the thousands place; dollar amounts are represented to the cent. * Every eligible compensation is returned for each employee. If no data has yet be inserted for a given field, it defaults to “0.00” (for fixed amounts) or “0.000” (for hours ). -* To return future payrolls, you must include an `end_date` in the future. * When include parameter with benefits value is passed, employee_benefits:read scope is required to return benefits * Benefits containing PHI are only visible with the `employee_benefits:read:phi` scope diff --git a/gusto_app_int/pyproject.toml b/gusto_app_int/pyproject.toml index 303ecb5c..9860f63e 100644 --- a/gusto_app_int/pyproject.toml +++ b/gusto_app_int/pyproject.toml @@ -1,6 +1,6 @@ [project] name = "gusto_app_integration" -version = "0.2.3" +version = "0.2.4" description = "Python Client SDK Generated by Speakeasy." authors = [{ name = "Speakeasy" },] readme = "README-PYPI.md" diff --git a/gusto_app_int/src/gusto_app_integration/_version.py b/gusto_app_int/src/gusto_app_integration/_version.py index 6f60b9c3..9f7ae2e0 100644 --- a/gusto_app_int/src/gusto_app_integration/_version.py +++ b/gusto_app_int/src/gusto_app_integration/_version.py @@ -3,11 +3,11 @@ import importlib.metadata __title__: str = "gusto_app_integration" -__version__: str = "0.2.3" +__version__: str = "0.2.4" __openapi_doc_version__: str = "2024-04-01" __gen_version__: str = "2.562.3" __user_agent__: str = ( - "speakeasy-sdk/python 0.2.3 2.562.3 2024-04-01 gusto_app_integration" + "speakeasy-sdk/python 0.2.4 2.562.3 2024-04-01 gusto_app_integration" ) try: diff --git a/gusto_app_int/src/gusto_app_integration/payrolls.py b/gusto_app_int/src/gusto_app_integration/payrolls.py index b80ca43c..2eba2cca 100644 --- a/gusto_app_int/src/gusto_app_integration/payrolls.py +++ b/gusto_app_int/src/gusto_app_integration/payrolls.py @@ -292,7 +292,6 @@ def get( * Hour and dollar amounts are returned as string representations of numeric decimals. * Hours are represented to the thousands place; dollar amounts are represented to the cent. * Every eligible compensation is returned for each employee. If no data has yet be inserted for a given field, it defaults to “0.00” (for fixed amounts) or “0.000” (for hours ). - * To return future payrolls, you must include an `end_date` in the future. * When include parameter with benefits value is passed, employee_benefits:read scope is required to return benefits * Benefits containing PHI are only visible with the `employee_benefits:read:phi` scope @@ -406,7 +405,6 @@ async def get_async( * Hour and dollar amounts are returned as string representations of numeric decimals. * Hours are represented to the thousands place; dollar amounts are represented to the cent. * Every eligible compensation is returned for each employee. If no data has yet be inserted for a given field, it defaults to “0.00” (for fixed amounts) or “0.000” (for hours ). - * To return future payrolls, you must include an `end_date` in the future. * When include parameter with benefits value is passed, employee_benefits:read scope is required to return benefits * Benefits containing PHI are only visible with the `employee_benefits:read:phi` scope diff --git a/gusto_embedded/.speakeasy/gen.lock b/gusto_embedded/.speakeasy/gen.lock index ca2a9873..0a50dca9 100644 --- a/gusto_embedded/.speakeasy/gen.lock +++ b/gusto_embedded/.speakeasy/gen.lock @@ -1,12 +1,12 @@ lockVersion: 2.0.0 id: f70034eb-4870-4b8d-aeb4-4c71b6c1ec45 management: - docChecksum: 9b5f6791f932c112cce1dbd387fca945 + docChecksum: 45800a345bc616357b155a0d3fc4bb47 docVersion: "2024-04-01" speakeasyVersion: 1.525.2 generationVersion: 2.562.3 - releaseVersion: 0.2.3 - configChecksum: cc6c24b6f3b84eaa0f761e5fb4c1e429 + releaseVersion: 0.2.4 + configChecksum: 4a34b2b32c48f121a16a7ededb3ed149 repoURL: https://github.com/Gusto/gusto-python-client.git repoSubDirectory: gusto_embedded installationURL: https://github.com/Gusto/gusto-python-client.git#subdirectory=gusto_embedded @@ -7961,7 +7961,7 @@ examples: X-Gusto-API-Version: "2024-04-01" responses: "200": - application/json: {"uuid": "7b1d0df1-6403-4a06-8768-c1dd7d24d27a", "company_uuid": "88f7cca1-dcad-4d20-84db-7fb80303d69f", "title": "Action required: Additional information needed to process payroll", "message": "If we do not receive this information as soon as possible, your payroll may not be processed on time.", "category": "information_request", "actionable": true, "published_at": "2022-01-01T00:00:00.000Z", "due_at": "2022-02-01T00:00:00.000Z", "resources": [{"entity_type": "Employee", "entity_uuid": "21b6f9ce-0ac4-4745-8d8a-127f8c0f00f2"}]} + application/json: {"uuid": "7b1d0df1-6403-4a06-8768-c1dd7d24d27a", "company_uuid": "88f7cca1-dcad-4d20-84db-7fb80303d69f", "title": "Action required: Additional information needed to process payroll", "message": "If we do not receive this information as soon as possible, your payroll may not be processed on time.", "category": "information_request", "actionable": true, "can_block_payroll": true, "published_at": "2022-01-01T00:00:00.000Z", "due_at": "2022-02-01T00:00:00.000Z", "resources": [{"entity_type": "Employee", "entity_uuid": "21b6f9ce-0ac4-4745-8d8a-127f8c0f00f2"}]} Basic: parameters: path: diff --git a/gusto_embedded/.speakeasy/gen.yaml b/gusto_embedded/.speakeasy/gen.yaml index 9ad0f7d1..431d6a96 100644 --- a/gusto_embedded/.speakeasy/gen.yaml +++ b/gusto_embedded/.speakeasy/gen.yaml @@ -18,7 +18,7 @@ generation: oAuth2ClientCredentialsEnabled: true oAuth2PasswordEnabled: true python: - version: 0.2.3 + version: 0.2.4 additionalDependencies: dev: {} main: {} diff --git a/gusto_embedded/docs/models/notification.md b/gusto_embedded/docs/models/notification.md index c47d1728..61d9ad32 100644 --- a/gusto_embedded/docs/models/notification.md +++ b/gusto_embedded/docs/models/notification.md @@ -5,14 +5,15 @@ Representation of a notification ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -| `uuid` | *str* | :heavy_check_mark: | Unique identifier of a notification. | -| `company_uuid` | *Optional[str]* | :heavy_minus_sign: | Unique identifier of the company to which the notification belongs. | -| `title` | *Optional[str]* | :heavy_minus_sign: | The title of the notification. This highlights the actionable component of the notification. | -| `message` | *Optional[str]* | :heavy_minus_sign: | The message of the notification. This provides additional context for the user and recommends a specific action to resolve the notification. | -| `category` | *Optional[str]* | :heavy_minus_sign: | The notification's category. | -| `actionable` | *Optional[bool]* | :heavy_minus_sign: | Indicates whether a notification requires action or not. If false, the notification provides critical information only. | -| `published_at` | *Optional[str]* | :heavy_minus_sign: | Timestamp of when the notification was published. | -| `due_at` | *Optional[str]* | :heavy_minus_sign: | Timestamp of when the notification is due. If the notification has no due date, this field will be null. | -| `resources` | List[[models.Resources](../models/resources.md)] | :heavy_minus_sign: | An array of entities relevant to the notification | \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | +| `uuid` | *str* | :heavy_check_mark: | Unique identifier of a notification. | +| `company_uuid` | *Optional[str]* | :heavy_minus_sign: | Unique identifier of the company to which the notification belongs. | +| `title` | *Optional[str]* | :heavy_minus_sign: | The title of the notification. This highlights the actionable component of the notification. | +| `message` | *Optional[str]* | :heavy_minus_sign: | The message of the notification. This provides additional context for the user and recommends a specific action to resolve the notification. | +| `category` | *Optional[str]* | :heavy_minus_sign: | The notification's category. | +| `actionable` | *Optional[bool]* | :heavy_minus_sign: | Indicates whether a notification requires action or not. If false, the notification provides critical information only. | +| `can_block_payroll` | *Optional[bool]* | :heavy_minus_sign: | Indicates whether a notification may block ability to run payroll. If true, we suggest that these notifications are prioritized to your end users. | +| `published_at` | *Optional[str]* | :heavy_minus_sign: | Timestamp of when the notification was published. | +| `due_at` | *Optional[str]* | :heavy_minus_sign: | Timestamp of when the notification is due. If the notification has no due date, this field will be null. | +| `resources` | List[[models.Resources](../models/resources.md)] | :heavy_minus_sign: | An array of entities relevant to the notification | \ No newline at end of file diff --git a/gusto_embedded/docs/sdks/payrolls/README.md b/gusto_embedded/docs/sdks/payrolls/README.md index 0a12abe6..b234d0d9 100644 --- a/gusto_embedded/docs/sdks/payrolls/README.md +++ b/gusto_embedded/docs/sdks/payrolls/README.md @@ -193,7 +193,6 @@ Notes: * Hour and dollar amounts are returned as string representations of numeric decimals. * Hours are represented to the thousands place; dollar amounts are represented to the cent. * Every eligible compensation is returned for each employee. If no data has yet be inserted for a given field, it defaults to “0.00” (for fixed amounts) or “0.000” (for hours ). -* To return future payrolls, you must include an `end_date` in the future. * When include parameter with benefits value is passed, employee_benefits:read scope is required to return benefits * Benefits containing PHI are only visible with the `employee_benefits:read:phi` scope diff --git a/gusto_embedded/pyproject.toml b/gusto_embedded/pyproject.toml index 11c5bc59..2d7d0b5c 100644 --- a/gusto_embedded/pyproject.toml +++ b/gusto_embedded/pyproject.toml @@ -1,6 +1,6 @@ [project] name = "gusto_embedded" -version = "0.2.3" +version = "0.2.4" description = "Python Client SDK Generated by Speakeasy." authors = [{ name = "Speakeasy" },] readme = "README-PYPI.md" diff --git a/gusto_embedded/src/gusto_embedded/_version.py b/gusto_embedded/src/gusto_embedded/_version.py index 785bbe27..7e57bbc6 100644 --- a/gusto_embedded/src/gusto_embedded/_version.py +++ b/gusto_embedded/src/gusto_embedded/_version.py @@ -3,10 +3,10 @@ import importlib.metadata __title__: str = "gusto_embedded" -__version__: str = "0.2.3" +__version__: str = "0.2.4" __openapi_doc_version__: str = "2024-04-01" __gen_version__: str = "2.562.3" -__user_agent__: str = "speakeasy-sdk/python 0.2.3 2.562.3 2024-04-01 gusto_embedded" +__user_agent__: str = "speakeasy-sdk/python 0.2.4 2.562.3 2024-04-01 gusto_embedded" try: if __package__ is not None: diff --git a/gusto_embedded/src/gusto_embedded/models/notification.py b/gusto_embedded/src/gusto_embedded/models/notification.py index 8a1693b0..eebb49ff 100644 --- a/gusto_embedded/src/gusto_embedded/models/notification.py +++ b/gusto_embedded/src/gusto_embedded/models/notification.py @@ -46,6 +46,8 @@ class NotificationTypedDict(TypedDict): r"""The notification's category.""" actionable: NotRequired[bool] r"""Indicates whether a notification requires action or not. If false, the notification provides critical information only.""" + can_block_payroll: NotRequired[bool] + r"""Indicates whether a notification may block ability to run payroll. If true, we suggest that these notifications are prioritized to your end users.""" published_at: NotRequired[str] r"""Timestamp of when the notification was published.""" due_at: NotRequired[str] @@ -75,6 +77,9 @@ class Notification(BaseModel): actionable: Optional[bool] = None r"""Indicates whether a notification requires action or not. If false, the notification provides critical information only.""" + can_block_payroll: Optional[bool] = None + r"""Indicates whether a notification may block ability to run payroll. If true, we suggest that these notifications are prioritized to your end users.""" + published_at: Optional[str] = None r"""Timestamp of when the notification was published.""" diff --git a/gusto_embedded/src/gusto_embedded/payrolls.py b/gusto_embedded/src/gusto_embedded/payrolls.py index 74fb64e0..22ab61c2 100644 --- a/gusto_embedded/src/gusto_embedded/payrolls.py +++ b/gusto_embedded/src/gusto_embedded/payrolls.py @@ -813,7 +813,6 @@ def get( * Hour and dollar amounts are returned as string representations of numeric decimals. * Hours are represented to the thousands place; dollar amounts are represented to the cent. * Every eligible compensation is returned for each employee. If no data has yet be inserted for a given field, it defaults to “0.00” (for fixed amounts) or “0.000” (for hours ). - * To return future payrolls, you must include an `end_date` in the future. * When include parameter with benefits value is passed, employee_benefits:read scope is required to return benefits * Benefits containing PHI are only visible with the `employee_benefits:read:phi` scope @@ -929,7 +928,6 @@ async def get_async( * Hour and dollar amounts are returned as string representations of numeric decimals. * Hours are represented to the thousands place; dollar amounts are represented to the cent. * Every eligible compensation is returned for each employee. If no data has yet be inserted for a given field, it defaults to “0.00” (for fixed amounts) or “0.000” (for hours ). - * To return future payrolls, you must include an `end_date` in the future. * When include parameter with benefits value is passed, employee_benefits:read scope is required to return benefits * Benefits containing PHI are only visible with the `employee_benefits:read:phi` scope